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 int opp_parse_supplies(struct dev_pm_opp *opp, struct device *dev,
582 struct opp_table *opp_table)
584 u32 *microvolt, *microamp = NULL, *microwatt = NULL;
585 int supplies = opp_table->regulator_count;
586 int vcount, icount, pcount, ret, i, j;
587 struct property *prop = NULL;
590 /* Search for "opp-microvolt-<name>" */
591 if (opp_table->prop_name) {
592 snprintf(name, sizeof(name), "opp-microvolt-%s",
593 opp_table->prop_name);
594 prop = of_find_property(opp->np, name, NULL);
598 /* Search for "opp-microvolt" */
599 sprintf(name, "opp-microvolt");
600 prop = of_find_property(opp->np, name, NULL);
602 /* Missing property isn't a problem, but an invalid entry is */
604 if (unlikely(supplies == -1)) {
605 /* Initialize regulator_count */
606 opp_table->regulator_count = 0;
613 dev_err(dev, "%s: opp-microvolt missing although OPP managing regulators\n",
619 if (unlikely(supplies == -1)) {
620 /* Initialize regulator_count */
621 supplies = opp_table->regulator_count = 1;
622 } else if (unlikely(!supplies)) {
623 dev_err(dev, "%s: opp-microvolt wasn't expected\n", __func__);
627 vcount = of_property_count_u32_elems(opp->np, name);
629 dev_err(dev, "%s: Invalid %s property (%d)\n",
630 __func__, name, vcount);
634 /* There can be one or three elements per supply */
635 if (vcount != supplies && vcount != supplies * 3) {
636 dev_err(dev, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
637 __func__, name, vcount, supplies);
641 microvolt = kmalloc_array(vcount, sizeof(*microvolt), GFP_KERNEL);
645 ret = of_property_read_u32_array(opp->np, name, microvolt, vcount);
647 dev_err(dev, "%s: error parsing %s: %d\n", __func__, name, ret);
652 /* Search for "opp-microamp-<name>" */
654 if (opp_table->prop_name) {
655 snprintf(name, sizeof(name), "opp-microamp-%s",
656 opp_table->prop_name);
657 prop = of_find_property(opp->np, name, NULL);
661 /* Search for "opp-microamp" */
662 sprintf(name, "opp-microamp");
663 prop = of_find_property(opp->np, name, NULL);
667 icount = of_property_count_u32_elems(opp->np, name);
669 dev_err(dev, "%s: Invalid %s property (%d)\n", __func__,
675 if (icount != supplies) {
676 dev_err(dev, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
677 __func__, name, icount, supplies);
682 microamp = kmalloc_array(icount, sizeof(*microamp), GFP_KERNEL);
688 ret = of_property_read_u32_array(opp->np, name, microamp,
691 dev_err(dev, "%s: error parsing %s: %d\n", __func__,
698 /* Search for "opp-microwatt" */
699 sprintf(name, "opp-microwatt");
700 prop = of_find_property(opp->np, name, NULL);
703 pcount = of_property_count_u32_elems(opp->np, name);
705 dev_err(dev, "%s: Invalid %s property (%d)\n", __func__,
711 if (pcount != supplies) {
712 dev_err(dev, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
713 __func__, name, pcount, supplies);
718 microwatt = kmalloc_array(pcount, sizeof(*microwatt),
725 ret = of_property_read_u32_array(opp->np, name, microwatt,
728 dev_err(dev, "%s: error parsing %s: %d\n", __func__,
735 for (i = 0, j = 0; i < supplies; i++) {
736 opp->supplies[i].u_volt = microvolt[j++];
738 if (vcount == supplies) {
739 opp->supplies[i].u_volt_min = opp->supplies[i].u_volt;
740 opp->supplies[i].u_volt_max = opp->supplies[i].u_volt;
742 opp->supplies[i].u_volt_min = microvolt[j++];
743 opp->supplies[i].u_volt_max = microvolt[j++];
747 opp->supplies[i].u_amp = microamp[i];
750 opp->supplies[i].u_watt = microwatt[i];
764 * dev_pm_opp_of_remove_table() - Free OPP table entries created from static DT
766 * @dev: device pointer used to lookup OPP table.
768 * Free OPPs created using static entries present in DT.
770 void dev_pm_opp_of_remove_table(struct device *dev)
772 dev_pm_opp_remove_table(dev);
774 EXPORT_SYMBOL_GPL(dev_pm_opp_of_remove_table);
776 static int _read_rate(struct dev_pm_opp *new_opp, struct opp_table *opp_table,
777 struct device_node *np)
779 struct property *prop;
783 prop = of_find_property(np, "opp-hz", NULL);
787 count = prop->length / sizeof(u64);
788 if (opp_table->clk_count != count) {
789 pr_err("%s: Count mismatch between opp-hz and clk_count (%d %d)\n",
790 __func__, count, opp_table->clk_count);
794 rates = kmalloc_array(count, sizeof(*rates), GFP_KERNEL);
798 ret = of_property_read_u64_array(np, "opp-hz", rates, count);
800 pr_err("%s: Error parsing opp-hz: %d\n", __func__, ret);
803 * Rate is defined as an unsigned long in clk API, and so
804 * casting explicitly to its type. Must be fixed once rate is 64
805 * bit guaranteed in clk API.
807 for (i = 0; i < count; i++) {
808 new_opp->rates[i] = (unsigned long)rates[i];
810 /* This will happen for frequencies > 4.29 GHz */
811 WARN_ON(new_opp->rates[i] != rates[i]);
820 static int _read_bw(struct dev_pm_opp *new_opp, struct opp_table *opp_table,
821 struct device_node *np, bool peak)
823 const char *name = peak ? "opp-peak-kBps" : "opp-avg-kBps";
824 struct property *prop;
828 prop = of_find_property(np, name, NULL);
832 count = prop->length / sizeof(u32);
833 if (opp_table->path_count != count) {
834 pr_err("%s: Mismatch between %s and paths (%d %d)\n",
835 __func__, name, count, opp_table->path_count);
839 bw = kmalloc_array(count, sizeof(*bw), GFP_KERNEL);
843 ret = of_property_read_u32_array(np, name, bw, count);
845 pr_err("%s: Error parsing %s: %d\n", __func__, name, ret);
849 for (i = 0; i < count; i++) {
851 new_opp->bandwidth[i].peak = kBps_to_icc(bw[i]);
853 new_opp->bandwidth[i].avg = kBps_to_icc(bw[i]);
861 static int _read_opp_key(struct dev_pm_opp *new_opp,
862 struct opp_table *opp_table, struct device_node *np)
867 ret = _read_rate(new_opp, opp_table, np);
870 else if (ret != -ENODEV)
874 * Bandwidth consists of peak and average (optional) values:
875 * opp-peak-kBps = <path1_value path2_value>;
876 * opp-avg-kBps = <path1_value path2_value>;
878 ret = _read_bw(new_opp, opp_table, np, true);
881 ret = _read_bw(new_opp, opp_table, np, false);
884 /* The properties were found but we failed to parse them */
885 if (ret && ret != -ENODEV)
888 if (!of_property_read_u32(np, "opp-level", &new_opp->level))
898 * _opp_add_static_v2() - Allocate static OPPs (As per 'v2' DT bindings)
899 * @opp_table: OPP table
900 * @dev: device for which we do this operation
903 * This function adds an opp definition to the opp table and returns status. The
904 * opp can be controlled using dev_pm_opp_enable/disable functions and may be
905 * removed by dev_pm_opp_remove.
911 * Duplicate OPPs (both freq and volt are same) and opp->available
912 * OR if the OPP is not supported by hardware.
914 * Freq are same and volt are different OR
915 * Duplicate OPPs (both freq and volt are same) and !opp->available
917 * Memory allocation failure
919 * Failed parsing the OPP node
921 static struct dev_pm_opp *_opp_add_static_v2(struct opp_table *opp_table,
922 struct device *dev, struct device_node *np)
924 struct dev_pm_opp *new_opp;
928 new_opp = _opp_allocate(opp_table);
930 return ERR_PTR(-ENOMEM);
932 ret = _read_opp_key(new_opp, opp_table, np);
934 dev_err(dev, "%s: opp key field not found\n", __func__);
938 /* Check if the OPP supports hardware's hierarchy of versions or not */
939 if (!_opp_is_supported(dev, opp_table, np)) {
940 dev_dbg(dev, "OPP not supported by hardware: %s\n",
941 of_node_full_name(np));
945 new_opp->turbo = of_property_read_bool(np, "turbo-mode");
947 new_opp->np = of_node_get(np);
948 new_opp->dynamic = false;
949 new_opp->available = true;
951 ret = _of_opp_alloc_required_opps(opp_table, new_opp);
955 if (!of_property_read_u32(np, "clock-latency-ns", &val))
956 new_opp->clock_latency_ns = val;
958 ret = opp_parse_supplies(new_opp, dev, opp_table);
960 goto free_required_opps;
962 if (opp_table->is_genpd)
963 new_opp->pstate = pm_genpd_opp_to_performance_state(dev, new_opp);
965 ret = _opp_add(dev, new_opp, opp_table);
967 /* Don't return error for duplicate OPPs */
970 goto free_required_opps;
973 /* OPP to select on device suspend */
974 if (of_property_read_bool(np, "opp-suspend")) {
975 if (opp_table->suspend_opp) {
976 /* Pick the OPP with higher rate/bw/level as suspend OPP */
977 if (_opp_compare_key(opp_table, new_opp, opp_table->suspend_opp) == 1) {
978 opp_table->suspend_opp->suspend = false;
979 new_opp->suspend = true;
980 opp_table->suspend_opp = new_opp;
983 new_opp->suspend = true;
984 opp_table->suspend_opp = new_opp;
988 if (new_opp->clock_latency_ns > opp_table->clock_latency_ns_max)
989 opp_table->clock_latency_ns_max = new_opp->clock_latency_ns;
991 pr_debug("%s: turbo:%d rate:%lu uv:%lu uvmin:%lu uvmax:%lu latency:%lu level:%u\n",
992 __func__, new_opp->turbo, new_opp->rates[0],
993 new_opp->supplies[0].u_volt, new_opp->supplies[0].u_volt_min,
994 new_opp->supplies[0].u_volt_max, new_opp->clock_latency_ns,
998 * Notify the changes in the availability of the operable
999 * frequency/voltage list.
1001 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1005 _of_opp_free_required_opps(opp_table, new_opp);
1009 return ret ? ERR_PTR(ret) : NULL;
1012 /* Initializes OPP tables based on new bindings */
1013 static int _of_add_opp_table_v2(struct device *dev, struct opp_table *opp_table)
1015 struct device_node *np;
1017 struct dev_pm_opp *opp;
1019 /* OPP table is already initialized for the device */
1020 mutex_lock(&opp_table->lock);
1021 if (opp_table->parsed_static_opps) {
1022 opp_table->parsed_static_opps++;
1023 mutex_unlock(&opp_table->lock);
1027 opp_table->parsed_static_opps = 1;
1028 mutex_unlock(&opp_table->lock);
1030 /* We have opp-table node now, iterate over it and add OPPs */
1031 for_each_available_child_of_node(opp_table->np, np) {
1032 opp = _opp_add_static_v2(opp_table, dev, np);
1035 dev_err(dev, "%s: Failed to add OPP, %d\n", __func__,
1038 goto remove_static_opp;
1044 /* There should be one or more OPPs defined */
1046 dev_err(dev, "%s: no supported OPPs", __func__);
1048 goto remove_static_opp;
1051 list_for_each_entry(opp, &opp_table->opp_list, node) {
1052 /* Any non-zero performance state would enable the feature */
1054 opp_table->genpd_performance_state = true;
1059 lazy_link_required_opp_table(opp_table);
1064 _opp_remove_all_static(opp_table);
1069 /* Initializes OPP tables based on old-deprecated bindings */
1070 static int _of_add_opp_table_v1(struct device *dev, struct opp_table *opp_table)
1072 const struct property *prop;
1076 mutex_lock(&opp_table->lock);
1077 if (opp_table->parsed_static_opps) {
1078 opp_table->parsed_static_opps++;
1079 mutex_unlock(&opp_table->lock);
1083 opp_table->parsed_static_opps = 1;
1084 mutex_unlock(&opp_table->lock);
1086 prop = of_find_property(dev->of_node, "operating-points", NULL);
1089 goto remove_static_opp;
1093 goto remove_static_opp;
1097 * Each OPP is a set of tuples consisting of frequency and
1098 * voltage like <freq-kHz vol-uV>.
1100 nr = prop->length / sizeof(u32);
1102 dev_err(dev, "%s: Invalid OPP table\n", __func__);
1104 goto remove_static_opp;
1109 unsigned long freq = be32_to_cpup(val++) * 1000;
1110 unsigned long volt = be32_to_cpup(val++);
1112 ret = _opp_add_v1(opp_table, dev, freq, volt, false);
1114 dev_err(dev, "%s: Failed to add OPP %ld (%d)\n",
1115 __func__, freq, ret);
1116 goto remove_static_opp;
1124 _opp_remove_all_static(opp_table);
1129 static int _of_add_table_indexed(struct device *dev, int index)
1131 struct opp_table *opp_table;
1136 * If only one phandle is present, then the same OPP table
1137 * applies for all index requests.
1139 count = of_count_phandle_with_args(dev->of_node,
1140 "operating-points-v2", NULL);
1145 opp_table = _add_opp_table_indexed(dev, index, true);
1146 if (IS_ERR(opp_table))
1147 return PTR_ERR(opp_table);
1150 * OPPs have two version of bindings now. Also try the old (v1)
1151 * bindings for backward compatibility with older dtbs.
1154 ret = _of_add_opp_table_v2(dev, opp_table);
1156 ret = _of_add_opp_table_v1(dev, opp_table);
1159 dev_pm_opp_put_opp_table(opp_table);
1164 static void devm_pm_opp_of_table_release(void *data)
1166 dev_pm_opp_of_remove_table(data);
1169 static int _devm_of_add_table_indexed(struct device *dev, int index)
1173 ret = _of_add_table_indexed(dev, index);
1177 return devm_add_action_or_reset(dev, devm_pm_opp_of_table_release, dev);
1181 * devm_pm_opp_of_add_table() - Initialize opp table from device tree
1182 * @dev: device pointer used to lookup OPP table.
1184 * Register the initial OPP table with the OPP library for given device.
1186 * The opp_table structure will be freed after the device is destroyed.
1190 * Duplicate OPPs (both freq and volt are same) and opp->available
1191 * -EEXIST Freq are same and volt are different OR
1192 * Duplicate OPPs (both freq and volt are same) and !opp->available
1193 * -ENOMEM Memory allocation failure
1194 * -ENODEV when 'operating-points' property is not found or is invalid data
1196 * -ENODATA when empty 'operating-points' property is found
1197 * -EINVAL when invalid entries are found in opp-v2 table
1199 int devm_pm_opp_of_add_table(struct device *dev)
1201 return _devm_of_add_table_indexed(dev, 0);
1203 EXPORT_SYMBOL_GPL(devm_pm_opp_of_add_table);
1206 * dev_pm_opp_of_add_table() - Initialize opp table from device tree
1207 * @dev: device pointer used to lookup OPP table.
1209 * Register the initial OPP table with the OPP library for given device.
1213 * Duplicate OPPs (both freq and volt are same) and opp->available
1214 * -EEXIST Freq are same and volt are different OR
1215 * Duplicate OPPs (both freq and volt are same) and !opp->available
1216 * -ENOMEM Memory allocation failure
1217 * -ENODEV when 'operating-points' property is not found or is invalid data
1219 * -ENODATA when empty 'operating-points' property is found
1220 * -EINVAL when invalid entries are found in opp-v2 table
1222 int dev_pm_opp_of_add_table(struct device *dev)
1224 return _of_add_table_indexed(dev, 0);
1226 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table);
1229 * dev_pm_opp_of_add_table_indexed() - Initialize indexed opp table from device tree
1230 * @dev: device pointer used to lookup OPP table.
1231 * @index: Index number.
1233 * Register the initial OPP table with the OPP library for given device only
1234 * using the "operating-points-v2" property.
1236 * Return: Refer to dev_pm_opp_of_add_table() for return values.
1238 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
1240 return _of_add_table_indexed(dev, index);
1242 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table_indexed);
1245 * devm_pm_opp_of_add_table_indexed() - Initialize indexed opp table from device tree
1246 * @dev: device pointer used to lookup OPP table.
1247 * @index: Index number.
1249 * This is a resource-managed variant of dev_pm_opp_of_add_table_indexed().
1251 int devm_pm_opp_of_add_table_indexed(struct device *dev, int index)
1253 return _devm_of_add_table_indexed(dev, index);
1255 EXPORT_SYMBOL_GPL(devm_pm_opp_of_add_table_indexed);
1257 /* CPU device specific helpers */
1260 * dev_pm_opp_of_cpumask_remove_table() - Removes OPP table for @cpumask
1261 * @cpumask: cpumask for which OPP table needs to be removed
1263 * This removes the OPP tables for CPUs present in the @cpumask.
1264 * This should be used only to remove static entries created from DT.
1266 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
1268 _dev_pm_opp_cpumask_remove_table(cpumask, -1);
1270 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_remove_table);
1273 * dev_pm_opp_of_cpumask_add_table() - Adds OPP table for @cpumask
1274 * @cpumask: cpumask for which OPP table needs to be added.
1276 * This adds the OPP tables for CPUs present in the @cpumask.
1278 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
1280 struct device *cpu_dev;
1283 if (WARN_ON(cpumask_empty(cpumask)))
1286 for_each_cpu(cpu, cpumask) {
1287 cpu_dev = get_cpu_device(cpu);
1289 pr_err("%s: failed to get cpu%d device\n", __func__,
1295 ret = dev_pm_opp_of_add_table(cpu_dev);
1298 * OPP may get registered dynamically, don't print error
1301 pr_debug("%s: couldn't find opp table for cpu:%d, %d\n",
1302 __func__, cpu, ret);
1311 /* Free all other OPPs */
1312 _dev_pm_opp_cpumask_remove_table(cpumask, cpu);
1316 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_add_table);
1319 * Works only for OPP v2 bindings.
1321 * Returns -ENOENT if operating-points-v2 bindings aren't supported.
1324 * dev_pm_opp_of_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with
1325 * @cpu_dev using operating-points-v2
1328 * @cpu_dev: CPU device for which we do this operation
1329 * @cpumask: cpumask to update with information of sharing CPUs
1331 * This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
1333 * Returns -ENOENT if operating-points-v2 isn't present for @cpu_dev.
1335 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev,
1336 struct cpumask *cpumask)
1338 struct device_node *np, *tmp_np, *cpu_np;
1341 /* Get OPP descriptor node */
1342 np = dev_pm_opp_of_get_opp_desc_node(cpu_dev);
1344 dev_dbg(cpu_dev, "%s: Couldn't find opp node.\n", __func__);
1348 cpumask_set_cpu(cpu_dev->id, cpumask);
1350 /* OPPs are shared ? */
1351 if (!of_property_read_bool(np, "opp-shared"))
1354 for_each_possible_cpu(cpu) {
1355 if (cpu == cpu_dev->id)
1358 cpu_np = of_cpu_device_node_get(cpu);
1360 dev_err(cpu_dev, "%s: failed to get cpu%d node\n",
1366 /* Get OPP descriptor node */
1367 tmp_np = _opp_of_get_opp_desc_node(cpu_np, 0);
1368 of_node_put(cpu_np);
1370 pr_err("%pOF: Couldn't find opp node\n", cpu_np);
1375 /* CPUs are sharing opp node */
1377 cpumask_set_cpu(cpu, cpumask);
1379 of_node_put(tmp_np);
1386 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_sharing_cpus);
1389 * of_get_required_opp_performance_state() - Search for required OPP and return its performance state.
1390 * @np: Node that contains the "required-opps" property.
1391 * @index: Index of the phandle to parse.
1393 * Returns the performance state of the OPP pointed out by the "required-opps"
1394 * property at @index in @np.
1396 * Return: Zero or positive performance state on success, otherwise negative
1399 int of_get_required_opp_performance_state(struct device_node *np, int index)
1401 struct dev_pm_opp *opp;
1402 struct device_node *required_np;
1403 struct opp_table *opp_table;
1404 int pstate = -EINVAL;
1406 required_np = of_parse_required_opp(np, index);
1410 opp_table = _find_table_of_opp_np(required_np);
1411 if (IS_ERR(opp_table)) {
1412 pr_err("%s: Failed to find required OPP table %pOF: %ld\n",
1413 __func__, np, PTR_ERR(opp_table));
1414 goto put_required_np;
1417 opp = _find_opp_of_np(opp_table, required_np);
1419 pstate = opp->pstate;
1420 dev_pm_opp_put(opp);
1423 dev_pm_opp_put_opp_table(opp_table);
1426 of_node_put(required_np);
1430 EXPORT_SYMBOL_GPL(of_get_required_opp_performance_state);
1433 * dev_pm_opp_get_of_node() - Gets the DT node corresponding to an opp
1434 * @opp: opp for which DT node has to be returned for
1436 * Return: DT node corresponding to the opp, else 0 on success.
1438 * The caller needs to put the node with of_node_put() after using it.
1440 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
1442 if (IS_ERR_OR_NULL(opp)) {
1443 pr_err("%s: Invalid parameters\n", __func__);
1447 return of_node_get(opp->np);
1449 EXPORT_SYMBOL_GPL(dev_pm_opp_get_of_node);
1452 * Callback function provided to the Energy Model framework upon registration.
1453 * It provides the power used by @dev at @kHz if it is the frequency of an
1454 * existing OPP, or at the frequency of the first OPP above @kHz otherwise
1455 * (see dev_pm_opp_find_freq_ceil()). This function updates @kHz to the ceiled
1456 * frequency and @uW to the associated power.
1458 * Returns 0 on success or a proper -EINVAL value in case of error.
1460 static int __maybe_unused
1461 _get_dt_power(struct device *dev, unsigned long *uW, unsigned long *kHz)
1463 struct dev_pm_opp *opp;
1464 unsigned long opp_freq, opp_power;
1466 /* Find the right frequency and related OPP */
1467 opp_freq = *kHz * 1000;
1468 opp = dev_pm_opp_find_freq_ceil(dev, &opp_freq);
1472 opp_power = dev_pm_opp_get_power(opp);
1473 dev_pm_opp_put(opp);
1477 *kHz = opp_freq / 1000;
1484 * Callback function provided to the Energy Model framework upon registration.
1485 * This computes the power estimated by @dev at @kHz if it is the frequency
1486 * of an existing OPP, or at the frequency of the first OPP above @kHz otherwise
1487 * (see dev_pm_opp_find_freq_ceil()). This function updates @kHz to the ceiled
1488 * frequency and @uW to the associated power. The power is estimated as
1489 * P = C * V^2 * f with C being the device's capacitance and V and f
1490 * respectively the voltage and frequency of the OPP.
1492 * Returns -EINVAL if the power calculation failed because of missing
1493 * parameters, 0 otherwise.
1495 static int __maybe_unused _get_power(struct device *dev, unsigned long *uW,
1498 struct dev_pm_opp *opp;
1499 struct device_node *np;
1500 unsigned long mV, Hz;
1505 np = of_node_get(dev->of_node);
1509 ret = of_property_read_u32(np, "dynamic-power-coefficient", &cap);
1515 opp = dev_pm_opp_find_freq_ceil(dev, &Hz);
1519 mV = dev_pm_opp_get_voltage(opp) / 1000;
1520 dev_pm_opp_put(opp);
1524 tmp = (u64)cap * mV * mV * (Hz / 1000000);
1525 /* Provide power in micro-Watts */
1526 do_div(tmp, 1000000);
1528 *uW = (unsigned long)tmp;
1534 static bool _of_has_opp_microwatt_property(struct device *dev)
1536 unsigned long power, freq = 0;
1537 struct dev_pm_opp *opp;
1539 /* Check if at least one OPP has needed property */
1540 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
1544 power = dev_pm_opp_get_power(opp);
1545 dev_pm_opp_put(opp);
1553 * dev_pm_opp_of_register_em() - Attempt to register an Energy Model
1554 * @dev : Device for which an Energy Model has to be registered
1555 * @cpus : CPUs for which an Energy Model has to be registered. For
1556 * other type of devices it should be set to NULL.
1558 * This checks whether the "dynamic-power-coefficient" devicetree property has
1559 * been specified, and tries to register an Energy Model with it if it has.
1560 * Having this property means the voltages are known for OPPs and the EM
1561 * might be calculated.
1563 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus)
1565 struct em_data_callback em_cb;
1566 struct device_node *np;
1570 if (IS_ERR_OR_NULL(dev)) {
1575 nr_opp = dev_pm_opp_get_opp_count(dev);
1581 /* First, try to find more precised Energy Model in DT */
1582 if (_of_has_opp_microwatt_property(dev)) {
1583 EM_SET_ACTIVE_POWER_CB(em_cb, _get_dt_power);
1587 np = of_node_get(dev->of_node);
1594 * Register an EM only if the 'dynamic-power-coefficient' property is
1595 * set in devicetree. It is assumed the voltage values are known if that
1596 * property is set since it is useless otherwise. If voltages are not
1597 * known, just let the EM registration fail with an error to alert the
1598 * user about the inconsistent configuration.
1600 ret = of_property_read_u32(np, "dynamic-power-coefficient", &cap);
1603 dev_dbg(dev, "Couldn't find proper 'dynamic-power-coefficient' in DT\n");
1608 EM_SET_ACTIVE_POWER_CB(em_cb, _get_power);
1611 ret = em_dev_register_perf_domain(dev, nr_opp, &em_cb, cpus, true);
1618 dev_dbg(dev, "Couldn't register Energy Model %d\n", ret);
1621 EXPORT_SYMBOL_GPL(dev_pm_opp_of_register_em);