2 * ARM big.LITTLE Platforms CPUFreq support
4 * Copyright (C) 2013 ARM Ltd.
5 * Sudeep KarkadaNagesha <sudeep.karkadanagesha@arm.com>
7 * Copyright (C) 2013 Linaro.
8 * Viresh Kumar <viresh.kumar@linaro.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
15 * kind, whether express or implied; without even the implied warranty
16 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
20 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22 #include <linux/clk.h>
23 #include <linux/cpu.h>
24 #include <linux/cpufreq.h>
25 #include <linux/cpumask.h>
26 #include <linux/cpu_cooling.h>
27 #include <linux/export.h>
28 #include <linux/module.h>
29 #include <linux/mutex.h>
30 #include <linux/of_platform.h>
31 #include <linux/pm_opp.h>
32 #include <linux/slab.h>
33 #include <linux/topology.h>
34 #include <linux/types.h>
36 #include "arm_big_little.h"
38 /* Currently we support only two clusters */
41 #define MAX_CLUSTERS 2
43 #ifdef CONFIG_BL_SWITCHER
44 #include <asm/bL_switcher.h>
45 static bool bL_switching_enabled
;
46 #define is_bL_switching_enabled() bL_switching_enabled
47 #define set_switching_enabled(x) (bL_switching_enabled = (x))
49 #define is_bL_switching_enabled() false
50 #define set_switching_enabled(x) do { } while (0)
51 #define bL_switch_request(...) do { } while (0)
52 #define bL_switcher_put_enabled() do { } while (0)
53 #define bL_switcher_get_enabled() do { } while (0)
56 #define ACTUAL_FREQ(cluster, freq) ((cluster == A7_CLUSTER) ? freq << 1 : freq)
57 #define VIRT_FREQ(cluster, freq) ((cluster == A7_CLUSTER) ? freq >> 1 : freq)
59 static struct thermal_cooling_device
*cdev
[MAX_CLUSTERS
];
60 static struct cpufreq_arm_bL_ops
*arm_bL_ops
;
61 static struct clk
*clk
[MAX_CLUSTERS
];
62 static struct cpufreq_frequency_table
*freq_table
[MAX_CLUSTERS
+ 1];
63 static atomic_t cluster_usage
[MAX_CLUSTERS
+ 1];
65 static unsigned int clk_big_min
; /* (Big) clock frequencies */
66 static unsigned int clk_little_max
; /* Maximum clock frequency (Little) */
68 static DEFINE_PER_CPU(unsigned int, physical_cluster
);
69 static DEFINE_PER_CPU(unsigned int, cpu_last_req_freq
);
71 static struct mutex cluster_lock
[MAX_CLUSTERS
];
73 static inline int raw_cpu_to_cluster(int cpu
)
75 return topology_physical_package_id(cpu
);
78 static inline int cpu_to_cluster(int cpu
)
80 return is_bL_switching_enabled() ?
81 MAX_CLUSTERS
: raw_cpu_to_cluster(cpu
);
84 static unsigned int find_cluster_maxfreq(int cluster
)
87 u32 max_freq
= 0, cpu_freq
;
89 for_each_online_cpu(j
) {
90 cpu_freq
= per_cpu(cpu_last_req_freq
, j
);
92 if ((cluster
== per_cpu(physical_cluster
, j
)) &&
93 (max_freq
< cpu_freq
))
97 pr_debug("%s: cluster: %d, max freq: %d\n", __func__
, cluster
,
103 static unsigned int clk_get_cpu_rate(unsigned int cpu
)
105 u32 cur_cluster
= per_cpu(physical_cluster
, cpu
);
106 u32 rate
= clk_get_rate(clk
[cur_cluster
]) / 1000;
108 /* For switcher we use virtual A7 clock rates */
109 if (is_bL_switching_enabled())
110 rate
= VIRT_FREQ(cur_cluster
, rate
);
112 pr_debug("%s: cpu: %d, cluster: %d, freq: %u\n", __func__
, cpu
,
118 static unsigned int bL_cpufreq_get_rate(unsigned int cpu
)
120 if (is_bL_switching_enabled()) {
121 pr_debug("%s: freq: %d\n", __func__
, per_cpu(cpu_last_req_freq
,
124 return per_cpu(cpu_last_req_freq
, cpu
);
126 return clk_get_cpu_rate(cpu
);
131 bL_cpufreq_set_rate(u32 cpu
, u32 old_cluster
, u32 new_cluster
, u32 rate
)
133 u32 new_rate
, prev_rate
;
135 bool bLs
= is_bL_switching_enabled();
137 mutex_lock(&cluster_lock
[new_cluster
]);
140 prev_rate
= per_cpu(cpu_last_req_freq
, cpu
);
141 per_cpu(cpu_last_req_freq
, cpu
) = rate
;
142 per_cpu(physical_cluster
, cpu
) = new_cluster
;
144 new_rate
= find_cluster_maxfreq(new_cluster
);
145 new_rate
= ACTUAL_FREQ(new_cluster
, new_rate
);
150 pr_debug("%s: cpu: %d, old cluster: %d, new cluster: %d, freq: %d\n",
151 __func__
, cpu
, old_cluster
, new_cluster
, new_rate
);
153 ret
= clk_set_rate(clk
[new_cluster
], new_rate
* 1000);
156 * FIXME: clk_set_rate hasn't returned an error here however it
157 * may be that clk_change_rate failed due to hardware or
158 * firmware issues and wasn't able to report that due to the
159 * current design of the clk core layer. To work around this
160 * problem we will read back the clock rate and check it is
161 * correct. This needs to be removed once clk core is fixed.
163 if (clk_get_rate(clk
[new_cluster
]) != new_rate
* 1000)
168 pr_err("clk_set_rate failed: %d, new cluster: %d\n", ret
,
171 per_cpu(cpu_last_req_freq
, cpu
) = prev_rate
;
172 per_cpu(physical_cluster
, cpu
) = old_cluster
;
175 mutex_unlock(&cluster_lock
[new_cluster
]);
180 mutex_unlock(&cluster_lock
[new_cluster
]);
182 /* Recalc freq for old cluster when switching clusters */
183 if (old_cluster
!= new_cluster
) {
184 pr_debug("%s: cpu: %d, old cluster: %d, new cluster: %d\n",
185 __func__
, cpu
, old_cluster
, new_cluster
);
188 bL_switch_request(cpu
, new_cluster
);
190 mutex_lock(&cluster_lock
[old_cluster
]);
192 /* Set freq of old cluster if there are cpus left on it */
193 new_rate
= find_cluster_maxfreq(old_cluster
);
194 new_rate
= ACTUAL_FREQ(old_cluster
, new_rate
);
197 pr_debug("%s: Updating rate of old cluster: %d, to freq: %d\n",
198 __func__
, old_cluster
, new_rate
);
200 if (clk_set_rate(clk
[old_cluster
], new_rate
* 1000))
201 pr_err("%s: clk_set_rate failed: %d, old cluster: %d\n",
202 __func__
, ret
, old_cluster
);
204 mutex_unlock(&cluster_lock
[old_cluster
]);
210 /* Set clock frequency */
211 static int bL_cpufreq_set_target(struct cpufreq_policy
*policy
,
214 u32 cpu
= policy
->cpu
, cur_cluster
, new_cluster
, actual_cluster
;
215 unsigned int freqs_new
;
217 cur_cluster
= cpu_to_cluster(cpu
);
218 new_cluster
= actual_cluster
= per_cpu(physical_cluster
, cpu
);
220 freqs_new
= freq_table
[cur_cluster
][index
].frequency
;
222 if (is_bL_switching_enabled()) {
223 if ((actual_cluster
== A15_CLUSTER
) &&
224 (freqs_new
< clk_big_min
)) {
225 new_cluster
= A7_CLUSTER
;
226 } else if ((actual_cluster
== A7_CLUSTER
) &&
227 (freqs_new
> clk_little_max
)) {
228 new_cluster
= A15_CLUSTER
;
232 return bL_cpufreq_set_rate(cpu
, actual_cluster
, new_cluster
, freqs_new
);
235 static inline u32
get_table_count(struct cpufreq_frequency_table
*table
)
239 for (count
= 0; table
[count
].frequency
!= CPUFREQ_TABLE_END
; count
++)
245 /* get the minimum frequency in the cpufreq_frequency_table */
246 static inline u32
get_table_min(struct cpufreq_frequency_table
*table
)
248 struct cpufreq_frequency_table
*pos
;
249 uint32_t min_freq
= ~0;
250 cpufreq_for_each_entry(pos
, table
)
251 if (pos
->frequency
< min_freq
)
252 min_freq
= pos
->frequency
;
256 /* get the maximum frequency in the cpufreq_frequency_table */
257 static inline u32
get_table_max(struct cpufreq_frequency_table
*table
)
259 struct cpufreq_frequency_table
*pos
;
260 uint32_t max_freq
= 0;
261 cpufreq_for_each_entry(pos
, table
)
262 if (pos
->frequency
> max_freq
)
263 max_freq
= pos
->frequency
;
267 static int merge_cluster_tables(void)
269 int i
, j
, k
= 0, count
= 1;
270 struct cpufreq_frequency_table
*table
;
272 for (i
= 0; i
< MAX_CLUSTERS
; i
++)
273 count
+= get_table_count(freq_table
[i
]);
275 table
= kzalloc(sizeof(*table
) * count
, GFP_KERNEL
);
279 freq_table
[MAX_CLUSTERS
] = table
;
281 /* Add in reverse order to get freqs in increasing order */
282 for (i
= MAX_CLUSTERS
- 1; i
>= 0; i
--) {
283 for (j
= 0; freq_table
[i
][j
].frequency
!= CPUFREQ_TABLE_END
;
285 table
[k
].frequency
= VIRT_FREQ(i
,
286 freq_table
[i
][j
].frequency
);
287 pr_debug("%s: index: %d, freq: %d\n", __func__
, k
,
293 table
[k
].driver_data
= k
;
294 table
[k
].frequency
= CPUFREQ_TABLE_END
;
296 pr_debug("%s: End, table: %p, count: %d\n", __func__
, table
, k
);
301 static void _put_cluster_clk_and_freq_table(struct device
*cpu_dev
)
303 u32 cluster
= raw_cpu_to_cluster(cpu_dev
->id
);
305 if (!freq_table
[cluster
])
308 clk_put(clk
[cluster
]);
309 dev_pm_opp_free_cpufreq_table(cpu_dev
, &freq_table
[cluster
]);
310 if (arm_bL_ops
->free_opp_table
)
311 arm_bL_ops
->free_opp_table(cpu_dev
);
312 dev_dbg(cpu_dev
, "%s: cluster: %d\n", __func__
, cluster
);
315 static void put_cluster_clk_and_freq_table(struct device
*cpu_dev
)
317 u32 cluster
= cpu_to_cluster(cpu_dev
->id
);
320 if (atomic_dec_return(&cluster_usage
[cluster
]))
323 if (cluster
< MAX_CLUSTERS
)
324 return _put_cluster_clk_and_freq_table(cpu_dev
);
326 for_each_present_cpu(i
) {
327 struct device
*cdev
= get_cpu_device(i
);
329 pr_err("%s: failed to get cpu%d device\n", __func__
, i
);
333 _put_cluster_clk_and_freq_table(cdev
);
336 /* free virtual table */
337 kfree(freq_table
[cluster
]);
340 static int _get_cluster_clk_and_freq_table(struct device
*cpu_dev
)
342 u32 cluster
= raw_cpu_to_cluster(cpu_dev
->id
);
345 if (freq_table
[cluster
])
348 ret
= arm_bL_ops
->init_opp_table(cpu_dev
);
350 dev_err(cpu_dev
, "%s: init_opp_table failed, cpu: %d, err: %d\n",
351 __func__
, cpu_dev
->id
, ret
);
355 ret
= dev_pm_opp_init_cpufreq_table(cpu_dev
, &freq_table
[cluster
]);
357 dev_err(cpu_dev
, "%s: failed to init cpufreq table, cpu: %d, err: %d\n",
358 __func__
, cpu_dev
->id
, ret
);
362 clk
[cluster
] = clk_get(cpu_dev
, NULL
);
363 if (!IS_ERR(clk
[cluster
])) {
364 dev_dbg(cpu_dev
, "%s: clk: %p & freq table: %p, cluster: %d\n",
365 __func__
, clk
[cluster
], freq_table
[cluster
],
370 dev_err(cpu_dev
, "%s: Failed to get clk for cpu: %d, cluster: %d\n",
371 __func__
, cpu_dev
->id
, cluster
);
372 ret
= PTR_ERR(clk
[cluster
]);
373 dev_pm_opp_free_cpufreq_table(cpu_dev
, &freq_table
[cluster
]);
376 if (arm_bL_ops
->free_opp_table
)
377 arm_bL_ops
->free_opp_table(cpu_dev
);
379 dev_err(cpu_dev
, "%s: Failed to get data for cluster: %d\n", __func__
,
384 static int get_cluster_clk_and_freq_table(struct device
*cpu_dev
)
386 u32 cluster
= cpu_to_cluster(cpu_dev
->id
);
389 if (atomic_inc_return(&cluster_usage
[cluster
]) != 1)
392 if (cluster
< MAX_CLUSTERS
) {
393 ret
= _get_cluster_clk_and_freq_table(cpu_dev
);
395 atomic_dec(&cluster_usage
[cluster
]);
400 * Get data for all clusters and fill virtual cluster with a merge of
403 for_each_present_cpu(i
) {
404 struct device
*cdev
= get_cpu_device(i
);
406 pr_err("%s: failed to get cpu%d device\n", __func__
, i
);
410 ret
= _get_cluster_clk_and_freq_table(cdev
);
415 ret
= merge_cluster_tables();
419 /* Assuming 2 cluster, set clk_big_min and clk_little_max */
420 clk_big_min
= get_table_min(freq_table
[0]);
421 clk_little_max
= VIRT_FREQ(1, get_table_max(freq_table
[1]));
423 pr_debug("%s: cluster: %d, clk_big_min: %d, clk_little_max: %d\n",
424 __func__
, cluster
, clk_big_min
, clk_little_max
);
429 for_each_present_cpu(i
) {
430 struct device
*cdev
= get_cpu_device(i
);
432 pr_err("%s: failed to get cpu%d device\n", __func__
, i
);
436 _put_cluster_clk_and_freq_table(cdev
);
439 atomic_dec(&cluster_usage
[cluster
]);
444 /* Per-CPU initialization */
445 static int bL_cpufreq_init(struct cpufreq_policy
*policy
)
447 u32 cur_cluster
= cpu_to_cluster(policy
->cpu
);
448 struct device
*cpu_dev
;
451 cpu_dev
= get_cpu_device(policy
->cpu
);
453 pr_err("%s: failed to get cpu%d device\n", __func__
,
458 ret
= get_cluster_clk_and_freq_table(cpu_dev
);
462 ret
= cpufreq_table_validate_and_show(policy
, freq_table
[cur_cluster
]);
464 dev_err(cpu_dev
, "CPU %d, cluster: %d invalid freq table\n",
465 policy
->cpu
, cur_cluster
);
466 put_cluster_clk_and_freq_table(cpu_dev
);
470 if (cur_cluster
< MAX_CLUSTERS
) {
473 cpumask_copy(policy
->cpus
, topology_core_cpumask(policy
->cpu
));
475 for_each_cpu(cpu
, policy
->cpus
)
476 per_cpu(physical_cluster
, cpu
) = cur_cluster
;
478 /* Assumption: during init, we are always running on A15 */
479 per_cpu(physical_cluster
, policy
->cpu
) = A15_CLUSTER
;
482 if (arm_bL_ops
->get_transition_latency
)
483 policy
->cpuinfo
.transition_latency
=
484 arm_bL_ops
->get_transition_latency(cpu_dev
);
486 policy
->cpuinfo
.transition_latency
= CPUFREQ_ETERNAL
;
488 if (is_bL_switching_enabled())
489 per_cpu(cpu_last_req_freq
, policy
->cpu
) = clk_get_cpu_rate(policy
->cpu
);
491 dev_info(cpu_dev
, "%s: CPU %d initialized\n", __func__
, policy
->cpu
);
495 static int bL_cpufreq_exit(struct cpufreq_policy
*policy
)
497 struct device
*cpu_dev
;
498 int cur_cluster
= cpu_to_cluster(policy
->cpu
);
500 if (cur_cluster
< MAX_CLUSTERS
) {
501 cpufreq_cooling_unregister(cdev
[cur_cluster
]);
502 cdev
[cur_cluster
] = NULL
;
505 cpu_dev
= get_cpu_device(policy
->cpu
);
507 pr_err("%s: failed to get cpu%d device\n", __func__
,
512 put_cluster_clk_and_freq_table(cpu_dev
);
513 dev_dbg(cpu_dev
, "%s: Exited, cpu: %d\n", __func__
, policy
->cpu
);
518 static void bL_cpufreq_ready(struct cpufreq_policy
*policy
)
520 struct device
*cpu_dev
= get_cpu_device(policy
->cpu
);
521 int cur_cluster
= cpu_to_cluster(policy
->cpu
);
522 struct device_node
*np
;
524 /* Do not register a cpu_cooling device if we are in IKS mode */
525 if (cur_cluster
>= MAX_CLUSTERS
)
528 np
= of_node_get(cpu_dev
->of_node
);
532 if (of_find_property(np
, "#cooling-cells", NULL
)) {
533 u32 power_coefficient
= 0;
535 of_property_read_u32(np
, "dynamic-power-coefficient",
538 cdev
[cur_cluster
] = of_cpufreq_power_cooling_register(np
,
539 policy
->related_cpus
, power_coefficient
, NULL
);
540 if (IS_ERR(cdev
[cur_cluster
])) {
542 "running cpufreq without cooling device: %ld\n",
543 PTR_ERR(cdev
[cur_cluster
]));
544 cdev
[cur_cluster
] = NULL
;
550 static struct cpufreq_driver bL_cpufreq_driver
= {
551 .name
= "arm-big-little",
552 .flags
= CPUFREQ_STICKY
|
553 CPUFREQ_HAVE_GOVERNOR_PER_POLICY
|
554 CPUFREQ_NEED_INITIAL_FREQ_CHECK
,
555 .verify
= cpufreq_generic_frequency_table_verify
,
556 .target_index
= bL_cpufreq_set_target
,
557 .get
= bL_cpufreq_get_rate
,
558 .init
= bL_cpufreq_init
,
559 .exit
= bL_cpufreq_exit
,
560 .ready
= bL_cpufreq_ready
,
561 .attr
= cpufreq_generic_attr
,
564 #ifdef CONFIG_BL_SWITCHER
565 static int bL_cpufreq_switcher_notifier(struct notifier_block
*nfb
,
566 unsigned long action
, void *_arg
)
568 pr_debug("%s: action: %ld\n", __func__
, action
);
571 case BL_NOTIFY_PRE_ENABLE
:
572 case BL_NOTIFY_PRE_DISABLE
:
573 cpufreq_unregister_driver(&bL_cpufreq_driver
);
576 case BL_NOTIFY_POST_ENABLE
:
577 set_switching_enabled(true);
578 cpufreq_register_driver(&bL_cpufreq_driver
);
581 case BL_NOTIFY_POST_DISABLE
:
582 set_switching_enabled(false);
583 cpufreq_register_driver(&bL_cpufreq_driver
);
593 static struct notifier_block bL_switcher_notifier
= {
594 .notifier_call
= bL_cpufreq_switcher_notifier
,
597 static int __bLs_register_notifier(void)
599 return bL_switcher_register_notifier(&bL_switcher_notifier
);
602 static int __bLs_unregister_notifier(void)
604 return bL_switcher_unregister_notifier(&bL_switcher_notifier
);
607 static int __bLs_register_notifier(void) { return 0; }
608 static int __bLs_unregister_notifier(void) { return 0; }
611 int bL_cpufreq_register(struct cpufreq_arm_bL_ops
*ops
)
616 pr_debug("%s: Already registered: %s, exiting\n", __func__
,
621 if (!ops
|| !strlen(ops
->name
) || !ops
->init_opp_table
) {
622 pr_err("%s: Invalid arm_bL_ops, exiting\n", __func__
);
628 set_switching_enabled(bL_switcher_get_enabled());
630 for (i
= 0; i
< MAX_CLUSTERS
; i
++)
631 mutex_init(&cluster_lock
[i
]);
633 ret
= cpufreq_register_driver(&bL_cpufreq_driver
);
635 pr_info("%s: Failed registering platform driver: %s, err: %d\n",
636 __func__
, ops
->name
, ret
);
639 ret
= __bLs_register_notifier();
641 cpufreq_unregister_driver(&bL_cpufreq_driver
);
644 pr_info("%s: Registered platform driver: %s\n",
645 __func__
, ops
->name
);
649 bL_switcher_put_enabled();
652 EXPORT_SYMBOL_GPL(bL_cpufreq_register
);
654 void bL_cpufreq_unregister(struct cpufreq_arm_bL_ops
*ops
)
656 if (arm_bL_ops
!= ops
) {
657 pr_err("%s: Registered with: %s, can't unregister, exiting\n",
658 __func__
, arm_bL_ops
->name
);
662 bL_switcher_get_enabled();
663 __bLs_unregister_notifier();
664 cpufreq_unregister_driver(&bL_cpufreq_driver
);
665 bL_switcher_put_enabled();
666 pr_info("%s: Un-registered platform driver: %s\n", __func__
,
670 EXPORT_SYMBOL_GPL(bL_cpufreq_unregister
);
672 MODULE_AUTHOR("Viresh Kumar <viresh.kumar@linaro.org>");
673 MODULE_DESCRIPTION("Generic ARM big LITTLE cpufreq driver");
674 MODULE_LICENSE("GPL v2");