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 struct device_node *required_np;
100 required_np = of_parse_phandle(np, "required-opps", index);
101 if (unlikely(!required_np)) {
102 pr_err("%s: Unable to parse required-opps: %pOF, index: %d\n",
103 __func__, np, index);
109 /* The caller must call dev_pm_opp_put_opp_table() after the table is used */
110 static struct opp_table *_find_table_of_opp_np(struct device_node *opp_np)
112 struct opp_table *opp_table;
113 struct device_node *opp_table_np;
115 opp_table_np = of_get_parent(opp_np);
119 /* It is safe to put the node now as all we need now is its address */
120 of_node_put(opp_table_np);
122 mutex_lock(&opp_table_lock);
123 list_for_each_entry(opp_table, &opp_tables, node) {
124 if (opp_table_np == opp_table->np) {
125 _get_opp_table_kref(opp_table);
126 mutex_unlock(&opp_table_lock);
130 mutex_unlock(&opp_table_lock);
133 return ERR_PTR(-ENODEV);
136 /* Free resources previously acquired by _opp_table_alloc_required_tables() */
137 static void _opp_table_free_required_tables(struct opp_table *opp_table)
139 struct opp_table **required_opp_tables = opp_table->required_opp_tables;
142 if (!required_opp_tables)
145 for (i = 0; i < opp_table->required_opp_count; i++) {
146 if (IS_ERR_OR_NULL(required_opp_tables[i]))
149 dev_pm_opp_put_opp_table(required_opp_tables[i]);
152 kfree(required_opp_tables);
154 opp_table->required_opp_count = 0;
155 opp_table->required_opp_tables = NULL;
156 list_del(&opp_table->lazy);
160 * Populate all devices and opp tables which are part of "required-opps" list.
161 * Checking only the first OPP node should be enough.
163 static void _opp_table_alloc_required_tables(struct opp_table *opp_table,
165 struct device_node *opp_np)
167 struct opp_table **required_opp_tables;
168 struct device_node *required_np, *np;
172 /* Traversing the first OPP node is all we need */
173 np = of_get_next_available_child(opp_np, NULL);
175 dev_warn(dev, "Empty OPP table\n");
180 count = of_count_phandle_with_args(np, "required-opps", NULL);
184 required_opp_tables = kcalloc(count, sizeof(*required_opp_tables),
186 if (!required_opp_tables)
189 opp_table->required_opp_tables = required_opp_tables;
190 opp_table->required_opp_count = count;
192 for (i = 0; i < count; i++) {
193 required_np = of_parse_required_opp(np, i);
195 goto free_required_tables;
197 required_opp_tables[i] = _find_table_of_opp_np(required_np);
198 of_node_put(required_np);
200 if (IS_ERR(required_opp_tables[i]))
204 /* Let's do the linking later on */
206 list_add(&opp_table->lazy, &lazy_opp_tables);
210 free_required_tables:
211 _opp_table_free_required_tables(opp_table);
216 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev,
219 struct device_node *np, *opp_np;
223 * Only required for backward compatibility with v1 bindings, but isn't
224 * harmful for other cases. And so we do it unconditionally.
226 np = of_node_get(dev->of_node);
230 if (!of_property_read_u32(np, "clock-latency", &val))
231 opp_table->clock_latency_ns_max = val;
232 of_property_read_u32(np, "voltage-tolerance",
233 &opp_table->voltage_tolerance_v1);
235 if (of_find_property(np, "#power-domain-cells", NULL))
236 opp_table->is_genpd = true;
238 /* Get OPP table node */
239 opp_np = _opp_of_get_opp_desc_node(np, index);
245 if (of_property_read_bool(opp_np, "opp-shared"))
246 opp_table->shared_opp = OPP_TABLE_ACCESS_SHARED;
248 opp_table->shared_opp = OPP_TABLE_ACCESS_EXCLUSIVE;
250 opp_table->np = opp_np;
252 _opp_table_alloc_required_tables(opp_table, dev, opp_np);
256 void _of_clear_opp_table(struct opp_table *opp_table)
258 _opp_table_free_required_tables(opp_table);
262 * Release all resources previously acquired with a call to
263 * _of_opp_alloc_required_opps().
265 void _of_opp_free_required_opps(struct opp_table *opp_table,
266 struct dev_pm_opp *opp)
268 struct dev_pm_opp **required_opps = opp->required_opps;
274 for (i = 0; i < opp_table->required_opp_count; i++) {
275 if (!required_opps[i])
278 /* Put the reference back */
279 dev_pm_opp_put(required_opps[i]);
282 opp->required_opps = NULL;
283 kfree(required_opps);
286 /* Populate all required OPPs which are part of "required-opps" list */
287 static int _of_opp_alloc_required_opps(struct opp_table *opp_table,
288 struct dev_pm_opp *opp)
290 struct dev_pm_opp **required_opps;
291 struct opp_table *required_table;
292 struct device_node *np;
293 int i, ret, count = opp_table->required_opp_count;
298 required_opps = kcalloc(count, sizeof(*required_opps), GFP_KERNEL);
302 opp->required_opps = required_opps;
304 for (i = 0; i < count; i++) {
305 required_table = opp_table->required_opp_tables[i];
307 /* Required table not added yet, we will link later */
308 if (IS_ERR_OR_NULL(required_table))
311 np = of_parse_required_opp(opp->np, i);
314 goto free_required_opps;
317 required_opps[i] = _find_opp_of_np(required_table, np);
320 if (!required_opps[i]) {
321 pr_err("%s: Unable to find required OPP node: %pOF (%d)\n",
322 __func__, opp->np, i);
324 goto free_required_opps;
331 _of_opp_free_required_opps(opp_table, opp);
336 /* Link required OPPs for an individual OPP */
337 static int lazy_link_required_opps(struct opp_table *opp_table,
338 struct opp_table *new_table, int index)
340 struct device_node *required_np;
341 struct dev_pm_opp *opp;
343 list_for_each_entry(opp, &opp_table->opp_list, node) {
344 required_np = of_parse_required_opp(opp->np, index);
345 if (unlikely(!required_np))
348 opp->required_opps[index] = _find_opp_of_np(new_table, required_np);
349 of_node_put(required_np);
351 if (!opp->required_opps[index]) {
352 pr_err("%s: Unable to find required OPP node: %pOF (%d)\n",
353 __func__, opp->np, index);
361 /* Link required OPPs for all OPPs of the newly added OPP table */
362 static void lazy_link_required_opp_table(struct opp_table *new_table)
364 struct opp_table *opp_table, *temp, **required_opp_tables;
365 struct device_node *required_np, *opp_np, *required_table_np;
366 struct dev_pm_opp *opp;
369 mutex_lock(&opp_table_lock);
371 list_for_each_entry_safe(opp_table, temp, &lazy_opp_tables, lazy) {
374 /* opp_np can't be invalid here */
375 opp_np = of_get_next_available_child(opp_table->np, NULL);
377 for (i = 0; i < opp_table->required_opp_count; i++) {
378 required_opp_tables = opp_table->required_opp_tables;
380 /* Required opp-table is already parsed */
381 if (!IS_ERR(required_opp_tables[i]))
384 /* required_np can't be invalid here */
385 required_np = of_parse_required_opp(opp_np, i);
386 required_table_np = of_get_parent(required_np);
388 of_node_put(required_table_np);
389 of_node_put(required_np);
392 * Newly added table isn't the required opp-table for
395 if (required_table_np != new_table->np) {
400 required_opp_tables[i] = new_table;
401 _get_opp_table_kref(new_table);
404 ret = lazy_link_required_opps(opp_table, new_table, i);
406 /* The OPPs will be marked unusable */
414 /* All required opp-tables found, remove from lazy list */
416 list_del_init(&opp_table->lazy);
418 list_for_each_entry(opp, &opp_table->opp_list, node)
419 _required_opps_available(opp, opp_table->required_opp_count);
423 mutex_unlock(&opp_table_lock);
426 static int _bandwidth_supported(struct device *dev, struct opp_table *opp_table)
428 struct device_node *np, *opp_np;
429 struct property *prop;
432 np = of_node_get(dev->of_node);
436 opp_np = _opp_of_get_opp_desc_node(np, 0);
439 opp_np = of_node_get(opp_table->np);
442 /* Lets not fail in case we are parsing opp-v1 bindings */
446 /* Checking only first OPP is sufficient */
447 np = of_get_next_available_child(opp_np, NULL);
449 dev_err(dev, "OPP table empty\n");
454 prop = of_find_property(np, "opp-peak-kBps", NULL);
457 if (!prop || !prop->length)
463 int dev_pm_opp_of_find_icc_paths(struct device *dev,
464 struct opp_table *opp_table)
466 struct device_node *np;
467 int ret, i, count, num_paths;
468 struct icc_path **paths;
470 ret = _bandwidth_supported(dev, opp_table);
472 return 0; /* Empty OPP table is a valid corner-case, let's not fail */
478 np = of_node_get(dev->of_node);
482 count = of_count_phandle_with_args(np, "interconnects",
483 "#interconnect-cells");
488 /* two phandles when #interconnect-cells = <1> */
490 dev_err(dev, "%s: Invalid interconnects values\n", __func__);
494 num_paths = count / 2;
495 paths = kcalloc(num_paths, sizeof(*paths), GFP_KERNEL);
499 for (i = 0; i < num_paths; i++) {
500 paths[i] = of_icc_get_by_index(dev, i);
501 if (IS_ERR(paths[i])) {
502 ret = PTR_ERR(paths[i]);
503 if (ret != -EPROBE_DEFER) {
504 dev_err(dev, "%s: Unable to get path%d: %d\n",
512 opp_table->paths = paths;
513 opp_table->path_count = num_paths;
525 EXPORT_SYMBOL_GPL(dev_pm_opp_of_find_icc_paths);
527 static bool _opp_is_supported(struct device *dev, struct opp_table *opp_table,
528 struct device_node *np)
530 unsigned int levels = opp_table->supported_hw_count;
531 int count, versions, ret, i, j;
534 if (!opp_table->supported_hw) {
536 * In the case that no supported_hw has been set by the
537 * platform but there is an opp-supported-hw value set for
538 * an OPP then the OPP should not be enabled as there is
539 * no way to see if the hardware supports it.
541 if (of_find_property(np, "opp-supported-hw", NULL))
547 count = of_property_count_u32_elems(np, "opp-supported-hw");
548 if (count <= 0 || count % levels) {
549 dev_err(dev, "%s: Invalid opp-supported-hw property (%d)\n",
554 versions = count / levels;
556 /* All levels in at least one of the versions should match */
557 for (i = 0; i < versions; i++) {
558 bool supported = true;
560 for (j = 0; j < levels; j++) {
561 ret = of_property_read_u32_index(np, "opp-supported-hw",
562 i * levels + j, &val);
564 dev_warn(dev, "%s: failed to read opp-supported-hw property at index %d: %d\n",
565 __func__, i * levels + j, ret);
569 /* Check if the level is supported */
570 if (!(val & opp_table->supported_hw[j])) {
583 static int opp_parse_supplies(struct dev_pm_opp *opp, struct device *dev,
584 struct opp_table *opp_table)
586 u32 *microvolt, *microamp = NULL;
587 int supplies = opp_table->regulator_count, vcount, icount, ret, i, j;
588 struct property *prop = NULL;
591 /* Search for "opp-microvolt-<name>" */
592 if (opp_table->prop_name) {
593 snprintf(name, sizeof(name), "opp-microvolt-%s",
594 opp_table->prop_name);
595 prop = of_find_property(opp->np, name, NULL);
599 /* Search for "opp-microvolt" */
600 sprintf(name, "opp-microvolt");
601 prop = of_find_property(opp->np, name, NULL);
603 /* Missing property isn't a problem, but an invalid entry is */
605 if (unlikely(supplies == -1)) {
606 /* Initialize regulator_count */
607 opp_table->regulator_count = 0;
614 dev_err(dev, "%s: opp-microvolt missing although OPP managing regulators\n",
620 if (unlikely(supplies == -1)) {
621 /* Initialize regulator_count */
622 supplies = opp_table->regulator_count = 1;
623 } else if (unlikely(!supplies)) {
624 dev_err(dev, "%s: opp-microvolt wasn't expected\n", __func__);
628 vcount = of_property_count_u32_elems(opp->np, name);
630 dev_err(dev, "%s: Invalid %s property (%d)\n",
631 __func__, name, vcount);
635 /* There can be one or three elements per supply */
636 if (vcount != supplies && vcount != supplies * 3) {
637 dev_err(dev, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
638 __func__, name, vcount, supplies);
642 microvolt = kmalloc_array(vcount, sizeof(*microvolt), GFP_KERNEL);
646 ret = of_property_read_u32_array(opp->np, name, microvolt, vcount);
648 dev_err(dev, "%s: error parsing %s: %d\n", __func__, name, ret);
653 /* Search for "opp-microamp-<name>" */
655 if (opp_table->prop_name) {
656 snprintf(name, sizeof(name), "opp-microamp-%s",
657 opp_table->prop_name);
658 prop = of_find_property(opp->np, name, NULL);
662 /* Search for "opp-microamp" */
663 sprintf(name, "opp-microamp");
664 prop = of_find_property(opp->np, name, NULL);
668 icount = of_property_count_u32_elems(opp->np, name);
670 dev_err(dev, "%s: Invalid %s property (%d)\n", __func__,
676 if (icount != supplies) {
677 dev_err(dev, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
678 __func__, name, icount, supplies);
683 microamp = kmalloc_array(icount, sizeof(*microamp), GFP_KERNEL);
689 ret = of_property_read_u32_array(opp->np, name, microamp,
692 dev_err(dev, "%s: error parsing %s: %d\n", __func__,
699 for (i = 0, j = 0; i < supplies; i++) {
700 opp->supplies[i].u_volt = microvolt[j++];
702 if (vcount == supplies) {
703 opp->supplies[i].u_volt_min = opp->supplies[i].u_volt;
704 opp->supplies[i].u_volt_max = opp->supplies[i].u_volt;
706 opp->supplies[i].u_volt_min = microvolt[j++];
707 opp->supplies[i].u_volt_max = microvolt[j++];
711 opp->supplies[i].u_amp = microamp[i];
723 * dev_pm_opp_of_remove_table() - Free OPP table entries created from static DT
725 * @dev: device pointer used to lookup OPP table.
727 * Free OPPs created using static entries present in DT.
729 void dev_pm_opp_of_remove_table(struct device *dev)
731 dev_pm_opp_remove_table(dev);
733 EXPORT_SYMBOL_GPL(dev_pm_opp_of_remove_table);
735 static int _read_bw(struct dev_pm_opp *new_opp, struct opp_table *table,
736 struct device_node *np, bool peak)
738 const char *name = peak ? "opp-peak-kBps" : "opp-avg-kBps";
739 struct property *prop;
743 prop = of_find_property(np, name, NULL);
747 count = prop->length / sizeof(u32);
748 if (table->path_count != count) {
749 pr_err("%s: Mismatch between %s and paths (%d %d)\n",
750 __func__, name, count, table->path_count);
754 bw = kmalloc_array(count, sizeof(*bw), GFP_KERNEL);
758 ret = of_property_read_u32_array(np, name, bw, count);
760 pr_err("%s: Error parsing %s: %d\n", __func__, name, ret);
764 for (i = 0; i < count; i++) {
766 new_opp->bandwidth[i].peak = kBps_to_icc(bw[i]);
768 new_opp->bandwidth[i].avg = kBps_to_icc(bw[i]);
776 static int _read_opp_key(struct dev_pm_opp *new_opp, struct opp_table *table,
777 struct device_node *np, bool *rate_not_available)
783 ret = of_property_read_u64(np, "opp-hz", &rate);
786 * Rate is defined as an unsigned long in clk API, and so
787 * casting explicitly to its type. Must be fixed once rate is 64
788 * bit guaranteed in clk API.
790 new_opp->rate = (unsigned long)rate;
793 *rate_not_available = !!ret;
796 * Bandwidth consists of peak and average (optional) values:
797 * opp-peak-kBps = <path1_value path2_value>;
798 * opp-avg-kBps = <path1_value path2_value>;
800 ret = _read_bw(new_opp, table, np, true);
803 ret = _read_bw(new_opp, table, np, false);
806 /* The properties were found but we failed to parse them */
807 if (ret && ret != -ENODEV)
810 if (!of_property_read_u32(np, "opp-level", &new_opp->level))
820 * _opp_add_static_v2() - Allocate static OPPs (As per 'v2' DT bindings)
821 * @opp_table: OPP table
822 * @dev: device for which we do this operation
825 * This function adds an opp definition to the opp table and returns status. The
826 * opp can be controlled using dev_pm_opp_enable/disable functions and may be
827 * removed by dev_pm_opp_remove.
833 * Duplicate OPPs (both freq and volt are same) and opp->available
834 * OR if the OPP is not supported by hardware.
836 * Freq are same and volt are different OR
837 * Duplicate OPPs (both freq and volt are same) and !opp->available
839 * Memory allocation failure
841 * Failed parsing the OPP node
843 static struct dev_pm_opp *_opp_add_static_v2(struct opp_table *opp_table,
844 struct device *dev, struct device_node *np)
846 struct dev_pm_opp *new_opp;
849 bool rate_not_available = false;
851 new_opp = _opp_allocate(opp_table);
853 return ERR_PTR(-ENOMEM);
855 ret = _read_opp_key(new_opp, opp_table, np, &rate_not_available);
857 dev_err(dev, "%s: opp key field not found\n", __func__);
861 /* Check if the OPP supports hardware's hierarchy of versions or not */
862 if (!_opp_is_supported(dev, opp_table, np)) {
863 dev_dbg(dev, "OPP not supported by hardware: %lu\n",
868 new_opp->turbo = of_property_read_bool(np, "turbo-mode");
871 new_opp->dynamic = false;
872 new_opp->available = true;
874 ret = _of_opp_alloc_required_opps(opp_table, new_opp);
878 if (!of_property_read_u32(np, "clock-latency-ns", &val))
879 new_opp->clock_latency_ns = val;
881 ret = opp_parse_supplies(new_opp, dev, opp_table);
883 goto free_required_opps;
885 if (opp_table->is_genpd)
886 new_opp->pstate = pm_genpd_opp_to_performance_state(dev, new_opp);
888 ret = _opp_add(dev, new_opp, opp_table, rate_not_available);
890 /* Don't return error for duplicate OPPs */
893 goto free_required_opps;
896 /* OPP to select on device suspend */
897 if (of_property_read_bool(np, "opp-suspend")) {
898 if (opp_table->suspend_opp) {
899 /* Pick the OPP with higher rate as suspend OPP */
900 if (new_opp->rate > opp_table->suspend_opp->rate) {
901 opp_table->suspend_opp->suspend = false;
902 new_opp->suspend = true;
903 opp_table->suspend_opp = new_opp;
906 new_opp->suspend = true;
907 opp_table->suspend_opp = new_opp;
911 if (new_opp->clock_latency_ns > opp_table->clock_latency_ns_max)
912 opp_table->clock_latency_ns_max = new_opp->clock_latency_ns;
914 pr_debug("%s: turbo:%d rate:%lu uv:%lu uvmin:%lu uvmax:%lu latency:%lu level:%u\n",
915 __func__, new_opp->turbo, new_opp->rate,
916 new_opp->supplies[0].u_volt, new_opp->supplies[0].u_volt_min,
917 new_opp->supplies[0].u_volt_max, new_opp->clock_latency_ns,
921 * Notify the changes in the availability of the operable
922 * frequency/voltage list.
924 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
928 _of_opp_free_required_opps(opp_table, new_opp);
935 /* Initializes OPP tables based on new bindings */
936 static int _of_add_opp_table_v2(struct device *dev, struct opp_table *opp_table)
938 struct device_node *np;
940 struct dev_pm_opp *opp;
942 /* OPP table is already initialized for the device */
943 mutex_lock(&opp_table->lock);
944 if (opp_table->parsed_static_opps) {
945 opp_table->parsed_static_opps++;
946 mutex_unlock(&opp_table->lock);
950 opp_table->parsed_static_opps = 1;
951 mutex_unlock(&opp_table->lock);
953 /* We have opp-table node now, iterate over it and add OPPs */
954 for_each_available_child_of_node(opp_table->np, np) {
955 opp = _opp_add_static_v2(opp_table, dev, np);
958 dev_err(dev, "%s: Failed to add OPP, %d\n", __func__,
961 goto remove_static_opp;
967 /* There should be one of more OPP defined */
968 if (WARN_ON(!count)) {
970 goto remove_static_opp;
973 list_for_each_entry(opp, &opp_table->opp_list, node) {
974 /* Any non-zero performance state would enable the feature */
976 opp_table->genpd_performance_state = true;
981 lazy_link_required_opp_table(opp_table);
986 _opp_remove_all_static(opp_table);
991 /* Initializes OPP tables based on old-deprecated bindings */
992 static int _of_add_opp_table_v1(struct device *dev, struct opp_table *opp_table)
994 const struct property *prop;
998 mutex_lock(&opp_table->lock);
999 if (opp_table->parsed_static_opps) {
1000 opp_table->parsed_static_opps++;
1001 mutex_unlock(&opp_table->lock);
1005 opp_table->parsed_static_opps = 1;
1006 mutex_unlock(&opp_table->lock);
1008 prop = of_find_property(dev->of_node, "operating-points", NULL);
1011 goto remove_static_opp;
1015 goto remove_static_opp;
1019 * Each OPP is a set of tuples consisting of frequency and
1020 * voltage like <freq-kHz vol-uV>.
1022 nr = prop->length / sizeof(u32);
1024 dev_err(dev, "%s: Invalid OPP table\n", __func__);
1026 goto remove_static_opp;
1031 unsigned long freq = be32_to_cpup(val++) * 1000;
1032 unsigned long volt = be32_to_cpup(val++);
1034 ret = _opp_add_v1(opp_table, dev, freq, volt, false);
1036 dev_err(dev, "%s: Failed to add OPP %ld (%d)\n",
1037 __func__, freq, ret);
1038 goto remove_static_opp;
1046 _opp_remove_all_static(opp_table);
1051 static int _of_add_table_indexed(struct device *dev, int index, bool getclk)
1053 struct opp_table *opp_table;
1058 * If only one phandle is present, then the same OPP table
1059 * applies for all index requests.
1061 count = of_count_phandle_with_args(dev->of_node,
1062 "operating-points-v2", NULL);
1067 opp_table = _add_opp_table_indexed(dev, index, getclk);
1068 if (IS_ERR(opp_table))
1069 return PTR_ERR(opp_table);
1072 * OPPs have two version of bindings now. Also try the old (v1)
1073 * bindings for backward compatibility with older dtbs.
1076 ret = _of_add_opp_table_v2(dev, opp_table);
1078 ret = _of_add_opp_table_v1(dev, opp_table);
1081 dev_pm_opp_put_opp_table(opp_table);
1086 static void devm_pm_opp_of_table_release(void *data)
1088 dev_pm_opp_of_remove_table(data);
1092 * devm_pm_opp_of_add_table() - Initialize opp table from device tree
1093 * @dev: device pointer used to lookup OPP table.
1095 * Register the initial OPP table with the OPP library for given device.
1097 * The opp_table structure will be freed after the device is destroyed.
1101 * Duplicate OPPs (both freq and volt are same) and opp->available
1102 * -EEXIST Freq are same and volt are different OR
1103 * Duplicate OPPs (both freq and volt are same) and !opp->available
1104 * -ENOMEM Memory allocation failure
1105 * -ENODEV when 'operating-points' property is not found or is invalid data
1107 * -ENODATA when empty 'operating-points' property is found
1108 * -EINVAL when invalid entries are found in opp-v2 table
1110 int devm_pm_opp_of_add_table(struct device *dev)
1114 ret = dev_pm_opp_of_add_table(dev);
1118 return devm_add_action_or_reset(dev, devm_pm_opp_of_table_release, dev);
1120 EXPORT_SYMBOL_GPL(devm_pm_opp_of_add_table);
1123 * dev_pm_opp_of_add_table() - Initialize opp table from device tree
1124 * @dev: device pointer used to lookup OPP table.
1126 * Register the initial OPP table with the OPP library for given device.
1130 * Duplicate OPPs (both freq and volt are same) and opp->available
1131 * -EEXIST Freq are same and volt are different OR
1132 * Duplicate OPPs (both freq and volt are same) and !opp->available
1133 * -ENOMEM Memory allocation failure
1134 * -ENODEV when 'operating-points' property is not found or is invalid data
1136 * -ENODATA when empty 'operating-points' property is found
1137 * -EINVAL when invalid entries are found in opp-v2 table
1139 int dev_pm_opp_of_add_table(struct device *dev)
1141 return _of_add_table_indexed(dev, 0, true);
1143 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table);
1146 * dev_pm_opp_of_add_table_indexed() - Initialize indexed opp table from device tree
1147 * @dev: device pointer used to lookup OPP table.
1148 * @index: Index number.
1150 * Register the initial OPP table with the OPP library for given device only
1151 * using the "operating-points-v2" property.
1153 * Return: Refer to dev_pm_opp_of_add_table() for return values.
1155 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
1157 return _of_add_table_indexed(dev, index, true);
1159 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table_indexed);
1162 * dev_pm_opp_of_add_table_noclk() - Initialize indexed opp table from device
1163 * tree without getting clk for device.
1164 * @dev: device pointer used to lookup OPP table.
1165 * @index: Index number.
1167 * Register the initial OPP table with the OPP library for given device only
1168 * using the "operating-points-v2" property. Do not try to get the clk for the
1171 * Return: Refer to dev_pm_opp_of_add_table() for return values.
1173 int dev_pm_opp_of_add_table_noclk(struct device *dev, int index)
1175 return _of_add_table_indexed(dev, index, false);
1177 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table_noclk);
1179 /* CPU device specific helpers */
1182 * dev_pm_opp_of_cpumask_remove_table() - Removes OPP table for @cpumask
1183 * @cpumask: cpumask for which OPP table needs to be removed
1185 * This removes the OPP tables for CPUs present in the @cpumask.
1186 * This should be used only to remove static entries created from DT.
1188 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
1190 _dev_pm_opp_cpumask_remove_table(cpumask, -1);
1192 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_remove_table);
1195 * dev_pm_opp_of_cpumask_add_table() - Adds OPP table for @cpumask
1196 * @cpumask: cpumask for which OPP table needs to be added.
1198 * This adds the OPP tables for CPUs present in the @cpumask.
1200 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
1202 struct device *cpu_dev;
1205 if (WARN_ON(cpumask_empty(cpumask)))
1208 for_each_cpu(cpu, cpumask) {
1209 cpu_dev = get_cpu_device(cpu);
1211 pr_err("%s: failed to get cpu%d device\n", __func__,
1217 ret = dev_pm_opp_of_add_table(cpu_dev);
1220 * OPP may get registered dynamically, don't print error
1223 pr_debug("%s: couldn't find opp table for cpu:%d, %d\n",
1224 __func__, cpu, ret);
1233 /* Free all other OPPs */
1234 _dev_pm_opp_cpumask_remove_table(cpumask, cpu);
1238 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_add_table);
1241 * Works only for OPP v2 bindings.
1243 * Returns -ENOENT if operating-points-v2 bindings aren't supported.
1246 * dev_pm_opp_of_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with
1247 * @cpu_dev using operating-points-v2
1250 * @cpu_dev: CPU device for which we do this operation
1251 * @cpumask: cpumask to update with information of sharing CPUs
1253 * This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
1255 * Returns -ENOENT if operating-points-v2 isn't present for @cpu_dev.
1257 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev,
1258 struct cpumask *cpumask)
1260 struct device_node *np, *tmp_np, *cpu_np;
1263 /* Get OPP descriptor node */
1264 np = dev_pm_opp_of_get_opp_desc_node(cpu_dev);
1266 dev_dbg(cpu_dev, "%s: Couldn't find opp node.\n", __func__);
1270 cpumask_set_cpu(cpu_dev->id, cpumask);
1272 /* OPPs are shared ? */
1273 if (!of_property_read_bool(np, "opp-shared"))
1276 for_each_possible_cpu(cpu) {
1277 if (cpu == cpu_dev->id)
1280 cpu_np = of_cpu_device_node_get(cpu);
1282 dev_err(cpu_dev, "%s: failed to get cpu%d node\n",
1288 /* Get OPP descriptor node */
1289 tmp_np = _opp_of_get_opp_desc_node(cpu_np, 0);
1290 of_node_put(cpu_np);
1292 pr_err("%pOF: Couldn't find opp node\n", cpu_np);
1297 /* CPUs are sharing opp node */
1299 cpumask_set_cpu(cpu, cpumask);
1301 of_node_put(tmp_np);
1308 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_sharing_cpus);
1311 * of_get_required_opp_performance_state() - Search for required OPP and return its performance state.
1312 * @np: Node that contains the "required-opps" property.
1313 * @index: Index of the phandle to parse.
1315 * Returns the performance state of the OPP pointed out by the "required-opps"
1316 * property at @index in @np.
1318 * Return: Zero or positive performance state on success, otherwise negative
1321 int of_get_required_opp_performance_state(struct device_node *np, int index)
1323 struct dev_pm_opp *opp;
1324 struct device_node *required_np;
1325 struct opp_table *opp_table;
1326 int pstate = -EINVAL;
1328 required_np = of_parse_required_opp(np, index);
1332 opp_table = _find_table_of_opp_np(required_np);
1333 if (IS_ERR(opp_table)) {
1334 pr_err("%s: Failed to find required OPP table %pOF: %ld\n",
1335 __func__, np, PTR_ERR(opp_table));
1336 goto put_required_np;
1339 opp = _find_opp_of_np(opp_table, required_np);
1341 pstate = opp->pstate;
1342 dev_pm_opp_put(opp);
1345 dev_pm_opp_put_opp_table(opp_table);
1348 of_node_put(required_np);
1352 EXPORT_SYMBOL_GPL(of_get_required_opp_performance_state);
1355 * dev_pm_opp_get_of_node() - Gets the DT node corresponding to an opp
1356 * @opp: opp for which DT node has to be returned for
1358 * Return: DT node corresponding to the opp, else 0 on success.
1360 * The caller needs to put the node with of_node_put() after using it.
1362 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
1364 if (IS_ERR_OR_NULL(opp)) {
1365 pr_err("%s: Invalid parameters\n", __func__);
1369 return of_node_get(opp->np);
1371 EXPORT_SYMBOL_GPL(dev_pm_opp_get_of_node);
1374 * Callback function provided to the Energy Model framework upon registration.
1375 * This computes the power estimated by @dev at @kHz if it is the frequency
1376 * of an existing OPP, or at the frequency of the first OPP above @kHz otherwise
1377 * (see dev_pm_opp_find_freq_ceil()). This function updates @kHz to the ceiled
1378 * frequency and @mW to the associated power. The power is estimated as
1379 * P = C * V^2 * f with C being the device's capacitance and V and f
1380 * respectively the voltage and frequency of the OPP.
1382 * Returns -EINVAL if the power calculation failed because of missing
1383 * parameters, 0 otherwise.
1385 static int __maybe_unused _get_power(unsigned long *mW, unsigned long *kHz,
1388 struct dev_pm_opp *opp;
1389 struct device_node *np;
1390 unsigned long mV, Hz;
1395 np = of_node_get(dev->of_node);
1399 ret = of_property_read_u32(np, "dynamic-power-coefficient", &cap);
1405 opp = dev_pm_opp_find_freq_ceil(dev, &Hz);
1409 mV = dev_pm_opp_get_voltage(opp) / 1000;
1410 dev_pm_opp_put(opp);
1414 tmp = (u64)cap * mV * mV * (Hz / 1000000);
1415 do_div(tmp, 1000000000);
1417 *mW = (unsigned long)tmp;
1424 * dev_pm_opp_of_register_em() - Attempt to register an Energy Model
1425 * @dev : Device for which an Energy Model has to be registered
1426 * @cpus : CPUs for which an Energy Model has to be registered. For
1427 * other type of devices it should be set to NULL.
1429 * This checks whether the "dynamic-power-coefficient" devicetree property has
1430 * been specified, and tries to register an Energy Model with it if it has.
1431 * Having this property means the voltages are known for OPPs and the EM
1432 * might be calculated.
1434 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus)
1436 struct em_data_callback em_cb = EM_DATA_CB(_get_power);
1437 struct device_node *np;
1441 if (IS_ERR_OR_NULL(dev)) {
1446 nr_opp = dev_pm_opp_get_opp_count(dev);
1452 np = of_node_get(dev->of_node);
1459 * Register an EM only if the 'dynamic-power-coefficient' property is
1460 * set in devicetree. It is assumed the voltage values are known if that
1461 * property is set since it is useless otherwise. If voltages are not
1462 * known, just let the EM registration fail with an error to alert the
1463 * user about the inconsistent configuration.
1465 ret = of_property_read_u32(np, "dynamic-power-coefficient", &cap);
1468 dev_dbg(dev, "Couldn't find proper 'dynamic-power-coefficient' in DT\n");
1473 ret = em_dev_register_perf_domain(dev, nr_opp, &em_cb, cpus, true);
1480 dev_dbg(dev, "Couldn't register Energy Model %d\n", ret);
1483 EXPORT_SYMBOL_GPL(dev_pm_opp_of_register_em);