2 * Generic OPP OF helpers
4 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/cpu.h>
17 #include <linux/errno.h>
18 #include <linux/device.h>
19 #include <linux/of_device.h>
20 #include <linux/slab.h>
21 #include <linux/export.h>
25 static struct opp_table *_managed_opp(const struct device_node *np)
27 struct opp_table *opp_table, *managed_table = NULL;
29 mutex_lock(&opp_table_lock);
31 list_for_each_entry(opp_table, &opp_tables, node) {
32 if (opp_table->np == np) {
34 * Multiple devices can point to the same OPP table and
35 * so will have same node-pointer, np.
37 * But the OPPs will be considered as shared only if the
38 * OPP table contains a "opp-shared" property.
40 if (opp_table->shared_opp == OPP_TABLE_ACCESS_SHARED) {
41 _get_opp_table_kref(opp_table);
42 managed_table = opp_table;
49 mutex_unlock(&opp_table_lock);
54 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev)
56 struct device_node *np;
59 * Only required for backward compatibility with v1 bindings, but isn't
60 * harmful for other cases. And so we do it unconditionally.
62 np = of_node_get(dev->of_node);
66 if (!of_property_read_u32(np, "clock-latency", &val))
67 opp_table->clock_latency_ns_max = val;
68 of_property_read_u32(np, "voltage-tolerance",
69 &opp_table->voltage_tolerance_v1);
74 static bool _opp_is_supported(struct device *dev, struct opp_table *opp_table,
75 struct device_node *np)
77 unsigned int count = opp_table->supported_hw_count;
81 if (!opp_table->supported_hw) {
83 * In the case that no supported_hw has been set by the
84 * platform but there is an opp-supported-hw value set for
85 * an OPP then the OPP should not be enabled as there is
86 * no way to see if the hardware supports it.
88 if (of_find_property(np, "opp-supported-hw", NULL))
95 ret = of_property_read_u32_index(np, "opp-supported-hw", count,
98 dev_warn(dev, "%s: failed to read opp-supported-hw property at index %d: %d\n",
99 __func__, count, ret);
103 /* Both of these are bitwise masks of the versions */
104 if (!(version & opp_table->supported_hw[count]))
111 static int opp_parse_supplies(struct dev_pm_opp *opp, struct device *dev,
112 struct opp_table *opp_table)
114 u32 *microvolt, *microamp = NULL;
115 int supplies, vcount, icount, ret, i, j;
116 struct property *prop = NULL;
119 supplies = opp_table->regulator_count ? opp_table->regulator_count : 1;
121 /* Search for "opp-microvolt-<name>" */
122 if (opp_table->prop_name) {
123 snprintf(name, sizeof(name), "opp-microvolt-%s",
124 opp_table->prop_name);
125 prop = of_find_property(opp->np, name, NULL);
129 /* Search for "opp-microvolt" */
130 sprintf(name, "opp-microvolt");
131 prop = of_find_property(opp->np, name, NULL);
133 /* Missing property isn't a problem, but an invalid entry is */
135 if (!opp_table->regulator_count)
138 dev_err(dev, "%s: opp-microvolt missing although OPP managing regulators\n",
144 vcount = of_property_count_u32_elems(opp->np, name);
146 dev_err(dev, "%s: Invalid %s property (%d)\n",
147 __func__, name, vcount);
151 /* There can be one or three elements per supply */
152 if (vcount != supplies && vcount != supplies * 3) {
153 dev_err(dev, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
154 __func__, name, vcount, supplies);
158 microvolt = kmalloc_array(vcount, sizeof(*microvolt), GFP_KERNEL);
162 ret = of_property_read_u32_array(opp->np, name, microvolt, vcount);
164 dev_err(dev, "%s: error parsing %s: %d\n", __func__, name, ret);
169 /* Search for "opp-microamp-<name>" */
171 if (opp_table->prop_name) {
172 snprintf(name, sizeof(name), "opp-microamp-%s",
173 opp_table->prop_name);
174 prop = of_find_property(opp->np, name, NULL);
178 /* Search for "opp-microamp" */
179 sprintf(name, "opp-microamp");
180 prop = of_find_property(opp->np, name, NULL);
184 icount = of_property_count_u32_elems(opp->np, name);
186 dev_err(dev, "%s: Invalid %s property (%d)\n", __func__,
192 if (icount != supplies) {
193 dev_err(dev, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
194 __func__, name, icount, supplies);
199 microamp = kmalloc_array(icount, sizeof(*microamp), GFP_KERNEL);
205 ret = of_property_read_u32_array(opp->np, name, microamp,
208 dev_err(dev, "%s: error parsing %s: %d\n", __func__,
215 for (i = 0, j = 0; i < supplies; i++) {
216 opp->supplies[i].u_volt = microvolt[j++];
218 if (vcount == supplies) {
219 opp->supplies[i].u_volt_min = opp->supplies[i].u_volt;
220 opp->supplies[i].u_volt_max = opp->supplies[i].u_volt;
222 opp->supplies[i].u_volt_min = microvolt[j++];
223 opp->supplies[i].u_volt_max = microvolt[j++];
227 opp->supplies[i].u_amp = microamp[i];
239 * dev_pm_opp_of_remove_table() - Free OPP table entries created from static DT
241 * @dev: device pointer used to lookup OPP table.
243 * Free OPPs created using static entries present in DT.
245 void dev_pm_opp_of_remove_table(struct device *dev)
247 _dev_pm_opp_find_and_remove_table(dev, false);
249 EXPORT_SYMBOL_GPL(dev_pm_opp_of_remove_table);
251 /* Returns opp descriptor node for a device node, caller must
252 * do of_node_put() */
253 static struct device_node *_opp_of_get_opp_desc_node(struct device_node *np)
256 * There should be only ONE phandle present in "operating-points-v2"
260 return of_parse_phandle(np, "operating-points-v2", 0);
263 /* Returns opp descriptor node for a device, caller must do of_node_put() */
264 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
266 return _opp_of_get_opp_desc_node(dev->of_node);
268 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_opp_desc_node);
271 * _opp_add_static_v2() - Allocate static OPPs (As per 'v2' DT bindings)
272 * @opp_table: OPP table
273 * @dev: device for which we do this operation
276 * This function adds an opp definition to the opp table and returns status. The
277 * opp can be controlled using dev_pm_opp_enable/disable functions and may be
278 * removed by dev_pm_opp_remove.
282 * Duplicate OPPs (both freq and volt are same) and opp->available
283 * -EEXIST Freq are same and volt are different OR
284 * Duplicate OPPs (both freq and volt are same) and !opp->available
285 * -ENOMEM Memory allocation failure
286 * -EINVAL Failed parsing the OPP node
288 static int _opp_add_static_v2(struct opp_table *opp_table, struct device *dev,
289 struct device_node *np)
291 struct dev_pm_opp *new_opp;
296 new_opp = _opp_allocate(opp_table);
300 ret = of_property_read_u64(np, "opp-hz", &rate);
302 dev_err(dev, "%s: opp-hz not found\n", __func__);
306 /* Check if the OPP supports hardware's hierarchy of versions or not */
307 if (!_opp_is_supported(dev, opp_table, np)) {
308 dev_dbg(dev, "OPP not supported by hardware: %llu\n", rate);
313 * Rate is defined as an unsigned long in clk API, and so casting
314 * explicitly to its type. Must be fixed once rate is 64 bit
315 * guaranteed in clk API.
317 new_opp->rate = (unsigned long)rate;
318 new_opp->turbo = of_property_read_bool(np, "turbo-mode");
321 new_opp->dynamic = false;
322 new_opp->available = true;
324 if (!of_property_read_u32(np, "clock-latency-ns", &val))
325 new_opp->clock_latency_ns = val;
327 ret = opp_parse_supplies(new_opp, dev, opp_table);
331 ret = _opp_add(dev, new_opp, opp_table);
333 /* Don't return error for duplicate OPPs */
339 /* OPP to select on device suspend */
340 if (of_property_read_bool(np, "opp-suspend")) {
341 if (opp_table->suspend_opp) {
342 dev_warn(dev, "%s: Multiple suspend OPPs found (%lu %lu)\n",
343 __func__, opp_table->suspend_opp->rate,
346 new_opp->suspend = true;
347 opp_table->suspend_opp = new_opp;
351 if (new_opp->clock_latency_ns > opp_table->clock_latency_ns_max)
352 opp_table->clock_latency_ns_max = new_opp->clock_latency_ns;
354 pr_debug("%s: turbo:%d rate:%lu uv:%lu uvmin:%lu uvmax:%lu latency:%lu\n",
355 __func__, new_opp->turbo, new_opp->rate,
356 new_opp->supplies[0].u_volt, new_opp->supplies[0].u_volt_min,
357 new_opp->supplies[0].u_volt_max, new_opp->clock_latency_ns);
360 * Notify the changes in the availability of the operable
361 * frequency/voltage list.
363 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
372 /* Initializes OPP tables based on new bindings */
373 static int _of_add_opp_table_v2(struct device *dev, struct device_node *opp_np)
375 struct device_node *np;
376 struct opp_table *opp_table;
377 int ret = 0, count = 0;
379 opp_table = _managed_opp(opp_np);
381 /* OPPs are already managed */
382 if (!_add_opp_dev(dev, opp_table))
387 opp_table = dev_pm_opp_get_opp_table(dev);
391 /* We have opp-table node now, iterate over it and add OPPs */
392 for_each_available_child_of_node(opp_np, np) {
395 ret = _opp_add_static_v2(opp_table, dev, np);
397 dev_err(dev, "%s: Failed to add OPP, %d\n", __func__,
399 _dev_pm_opp_remove_table(opp_table, dev, false);
405 /* There should be one of more OPP defined */
406 if (WARN_ON(!count)) {
411 opp_table->np = opp_np;
412 if (of_property_read_bool(opp_np, "opp-shared"))
413 opp_table->shared_opp = OPP_TABLE_ACCESS_SHARED;
415 opp_table->shared_opp = OPP_TABLE_ACCESS_EXCLUSIVE;
418 dev_pm_opp_put_opp_table(opp_table);
423 /* Initializes OPP tables based on old-deprecated bindings */
424 static int _of_add_opp_table_v1(struct device *dev)
426 struct opp_table *opp_table;
427 const struct property *prop;
431 prop = of_find_property(dev->of_node, "operating-points", NULL);
438 * Each OPP is a set of tuples consisting of frequency and
439 * voltage like <freq-kHz vol-uV>.
441 nr = prop->length / sizeof(u32);
443 dev_err(dev, "%s: Invalid OPP table\n", __func__);
447 opp_table = dev_pm_opp_get_opp_table(dev);
453 unsigned long freq = be32_to_cpup(val++) * 1000;
454 unsigned long volt = be32_to_cpup(val++);
456 ret = _opp_add_v1(opp_table, dev, freq, volt, false);
458 dev_err(dev, "%s: Failed to add OPP %ld (%d)\n",
459 __func__, freq, ret);
460 _dev_pm_opp_remove_table(opp_table, dev, false);
466 dev_pm_opp_put_opp_table(opp_table);
471 * dev_pm_opp_of_add_table() - Initialize opp table from device tree
472 * @dev: device pointer used to lookup OPP table.
474 * Register the initial OPP table with the OPP library for given device.
478 * Duplicate OPPs (both freq and volt are same) and opp->available
479 * -EEXIST Freq are same and volt are different OR
480 * Duplicate OPPs (both freq and volt are same) and !opp->available
481 * -ENOMEM Memory allocation failure
482 * -ENODEV when 'operating-points' property is not found or is invalid data
484 * -ENODATA when empty 'operating-points' property is found
485 * -EINVAL when invalid entries are found in opp-v2 table
487 int dev_pm_opp_of_add_table(struct device *dev)
489 struct device_node *opp_np;
493 * OPPs have two version of bindings now. The older one is deprecated,
494 * try for the new binding first.
496 opp_np = dev_pm_opp_of_get_opp_desc_node(dev);
499 * Try old-deprecated bindings for backward compatibility with
502 return _of_add_opp_table_v1(dev);
505 ret = _of_add_opp_table_v2(dev, opp_np);
510 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table);
512 /* CPU device specific helpers */
515 * dev_pm_opp_of_cpumask_remove_table() - Removes OPP table for @cpumask
516 * @cpumask: cpumask for which OPP table needs to be removed
518 * This removes the OPP tables for CPUs present in the @cpumask.
519 * This should be used only to remove static entries created from DT.
521 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
523 _dev_pm_opp_cpumask_remove_table(cpumask, true);
525 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_remove_table);
528 * dev_pm_opp_of_cpumask_add_table() - Adds OPP table for @cpumask
529 * @cpumask: cpumask for which OPP table needs to be added.
531 * This adds the OPP tables for CPUs present in the @cpumask.
533 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
535 struct device *cpu_dev;
538 WARN_ON(cpumask_empty(cpumask));
540 for_each_cpu(cpu, cpumask) {
541 cpu_dev = get_cpu_device(cpu);
543 pr_err("%s: failed to get cpu%d device\n", __func__,
548 ret = dev_pm_opp_of_add_table(cpu_dev);
551 * OPP may get registered dynamically, don't print error
554 pr_debug("%s: couldn't find opp table for cpu:%d, %d\n",
557 /* Free all other OPPs */
558 dev_pm_opp_of_cpumask_remove_table(cpumask);
565 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_add_table);
568 * Works only for OPP v2 bindings.
570 * Returns -ENOENT if operating-points-v2 bindings aren't supported.
573 * dev_pm_opp_of_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with
574 * @cpu_dev using operating-points-v2
577 * @cpu_dev: CPU device for which we do this operation
578 * @cpumask: cpumask to update with information of sharing CPUs
580 * This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
582 * Returns -ENOENT if operating-points-v2 isn't present for @cpu_dev.
584 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev,
585 struct cpumask *cpumask)
587 struct device_node *np, *tmp_np, *cpu_np;
590 /* Get OPP descriptor node */
591 np = dev_pm_opp_of_get_opp_desc_node(cpu_dev);
593 dev_dbg(cpu_dev, "%s: Couldn't find opp node.\n", __func__);
597 cpumask_set_cpu(cpu_dev->id, cpumask);
599 /* OPPs are shared ? */
600 if (!of_property_read_bool(np, "opp-shared"))
603 for_each_possible_cpu(cpu) {
604 if (cpu == cpu_dev->id)
607 cpu_np = of_cpu_device_node_get(cpu);
609 dev_err(cpu_dev, "%s: failed to get cpu%d node\n",
615 /* Get OPP descriptor node */
616 tmp_np = _opp_of_get_opp_desc_node(cpu_np);
619 pr_err("%pOF: Couldn't find opp node\n", cpu_np);
624 /* CPUs are sharing opp node */
626 cpumask_set_cpu(cpu, cpumask);
635 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_sharing_cpus);