]> git.karo-electronics.de Git - karo-tx-linux.git/blob - arch/arm/common/bL_switcher.c
ARM: bL_switcher: Add runtime control notifier
[karo-tx-linux.git] / arch / arm / common / bL_switcher.c
1 /*
2  * arch/arm/common/bL_switcher.c -- big.LITTLE cluster switcher core driver
3  *
4  * Created by:  Nicolas Pitre, March 2012
5  * Copyright:   (C) 2012-2013  Linaro Limited
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11
12 #include <linux/init.h>
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/sched.h>
16 #include <linux/interrupt.h>
17 #include <linux/cpu_pm.h>
18 #include <linux/cpu.h>
19 #include <linux/cpumask.h>
20 #include <linux/kthread.h>
21 #include <linux/wait.h>
22 #include <linux/clockchips.h>
23 #include <linux/hrtimer.h>
24 #include <linux/tick.h>
25 #include <linux/notifier.h>
26 #include <linux/mm.h>
27 #include <linux/mutex.h>
28 #include <linux/string.h>
29 #include <linux/sysfs.h>
30 #include <linux/irqchip/arm-gic.h>
31 #include <linux/moduleparam.h>
32
33 #include <asm/smp_plat.h>
34 #include <asm/suspend.h>
35 #include <asm/mcpm.h>
36 #include <asm/bL_switcher.h>
37
38
39 /*
40  * Use our own MPIDR accessors as the generic ones in asm/cputype.h have
41  * __attribute_const__ and we don't want the compiler to assume any
42  * constness here as the value _does_ change along some code paths.
43  */
44
45 static int read_mpidr(void)
46 {
47         unsigned int id;
48         asm volatile ("mrc p15, 0, %0, c0, c0, 5" : "=r" (id));
49         return id & MPIDR_HWID_BITMASK;
50 }
51
52 /*
53  * bL switcher core code.
54  */
55
56 static void bL_do_switch(void *_unused)
57 {
58         unsigned ib_mpidr, ib_cpu, ib_cluster;
59
60         pr_debug("%s\n", __func__);
61
62         ib_mpidr = cpu_logical_map(smp_processor_id());
63         ib_cpu = MPIDR_AFFINITY_LEVEL(ib_mpidr, 0);
64         ib_cluster = MPIDR_AFFINITY_LEVEL(ib_mpidr, 1);
65
66         /*
67          * Our state has been saved at this point.  Let's release our
68          * inbound CPU.
69          */
70         mcpm_set_entry_vector(ib_cpu, ib_cluster, cpu_resume);
71         sev();
72
73         /*
74          * From this point, we must assume that our counterpart CPU might
75          * have taken over in its parallel world already, as if execution
76          * just returned from cpu_suspend().  It is therefore important to
77          * be very careful not to make any change the other guy is not
78          * expecting.  This is why we need stack isolation.
79          *
80          * Fancy under cover tasks could be performed here.  For now
81          * we have none.
82          */
83
84         /* Let's put ourself down. */
85         mcpm_cpu_power_down();
86
87         /* should never get here */
88         BUG();
89 }
90
91 /*
92  * Stack isolation.  To ensure 'current' remains valid, we just use another
93  * piece of our thread's stack space which should be fairly lightly used.
94  * The selected area starts just above the thread_info structure located
95  * at the very bottom of the stack, aligned to a cache line, and indexed
96  * with the cluster number.
97  */
98 #define STACK_SIZE 512
99 extern void call_with_stack(void (*fn)(void *), void *arg, void *sp);
100 static int bL_switchpoint(unsigned long _arg)
101 {
102         unsigned int mpidr = read_mpidr();
103         unsigned int clusterid = MPIDR_AFFINITY_LEVEL(mpidr, 1);
104         void *stack = current_thread_info() + 1;
105         stack = PTR_ALIGN(stack, L1_CACHE_BYTES);
106         stack += clusterid * STACK_SIZE + STACK_SIZE;
107         call_with_stack(bL_do_switch, (void *)_arg, stack);
108         BUG();
109 }
110
111 /*
112  * Generic switcher interface
113  */
114
115 static unsigned int bL_gic_id[MAX_CPUS_PER_CLUSTER][MAX_NR_CLUSTERS];
116 static int bL_switcher_cpu_pairing[NR_CPUS];
117
118 /*
119  * bL_switch_to - Switch to a specific cluster for the current CPU
120  * @new_cluster_id: the ID of the cluster to switch to.
121  *
122  * This function must be called on the CPU to be switched.
123  * Returns 0 on success, else a negative status code.
124  */
125 static int bL_switch_to(unsigned int new_cluster_id)
126 {
127         unsigned int mpidr, this_cpu, that_cpu;
128         unsigned int ob_mpidr, ob_cpu, ob_cluster, ib_mpidr, ib_cpu, ib_cluster;
129         struct tick_device *tdev;
130         enum clock_event_mode tdev_mode;
131         int ret;
132
133         this_cpu = smp_processor_id();
134         ob_mpidr = read_mpidr();
135         ob_cpu = MPIDR_AFFINITY_LEVEL(ob_mpidr, 0);
136         ob_cluster = MPIDR_AFFINITY_LEVEL(ob_mpidr, 1);
137         BUG_ON(cpu_logical_map(this_cpu) != ob_mpidr);
138
139         if (new_cluster_id == ob_cluster)
140                 return 0;
141
142         that_cpu = bL_switcher_cpu_pairing[this_cpu];
143         ib_mpidr = cpu_logical_map(that_cpu);
144         ib_cpu = MPIDR_AFFINITY_LEVEL(ib_mpidr, 0);
145         ib_cluster = MPIDR_AFFINITY_LEVEL(ib_mpidr, 1);
146
147         pr_debug("before switch: CPU %d MPIDR %#x -> %#x\n",
148                  this_cpu, ob_mpidr, ib_mpidr);
149
150         /* Close the gate for our entry vectors */
151         mcpm_set_entry_vector(ob_cpu, ob_cluster, NULL);
152         mcpm_set_entry_vector(ib_cpu, ib_cluster, NULL);
153
154         /*
155          * Let's wake up the inbound CPU now in case it requires some delay
156          * to come online, but leave it gated in our entry vector code.
157          */
158         ret = mcpm_cpu_power_up(ib_cpu, ib_cluster);
159         if (ret) {
160                 pr_err("%s: mcpm_cpu_power_up() returned %d\n", __func__, ret);
161                 return ret;
162         }
163
164         /*
165          * From this point we are entering the switch critical zone
166          * and can't take any interrupts anymore.
167          */
168         local_irq_disable();
169         local_fiq_disable();
170
171         /* redirect GIC's SGIs to our counterpart */
172         gic_migrate_target(bL_gic_id[ib_cpu][ib_cluster]);
173
174         /*
175          * Raise a SGI on the inbound CPU to make sure it doesn't stall
176          * in a possible WFI, such as in mcpm_power_down().
177          */
178         arch_send_wakeup_ipi_mask(cpumask_of(this_cpu));
179
180         tdev = tick_get_device(this_cpu);
181         if (tdev && !cpumask_equal(tdev->evtdev->cpumask, cpumask_of(this_cpu)))
182                 tdev = NULL;
183         if (tdev) {
184                 tdev_mode = tdev->evtdev->mode;
185                 clockevents_set_mode(tdev->evtdev, CLOCK_EVT_MODE_SHUTDOWN);
186         }
187
188         ret = cpu_pm_enter();
189
190         /* we can not tolerate errors at this point */
191         if (ret)
192                 panic("%s: cpu_pm_enter() returned %d\n", __func__, ret);
193
194         /* Swap the physical CPUs in the logical map for this logical CPU. */
195         cpu_logical_map(this_cpu) = ib_mpidr;
196         cpu_logical_map(that_cpu) = ob_mpidr;
197
198         /* Let's do the actual CPU switch. */
199         ret = cpu_suspend(0, bL_switchpoint);
200         if (ret > 0)
201                 panic("%s: cpu_suspend() returned %d\n", __func__, ret);
202
203         /* We are executing on the inbound CPU at this point */
204         mpidr = read_mpidr();
205         pr_debug("after switch: CPU %d MPIDR %#x\n", this_cpu, mpidr);
206         BUG_ON(mpidr != ib_mpidr);
207
208         mcpm_cpu_powered_up();
209
210         ret = cpu_pm_exit();
211
212         if (tdev) {
213                 clockevents_set_mode(tdev->evtdev, tdev_mode);
214                 clockevents_program_event(tdev->evtdev,
215                                           tdev->evtdev->next_event, 1);
216         }
217
218         local_fiq_enable();
219         local_irq_enable();
220
221         if (ret)
222                 pr_err("%s exiting with error %d\n", __func__, ret);
223         return ret;
224 }
225
226 struct bL_thread {
227         struct task_struct *task;
228         wait_queue_head_t wq;
229         int wanted_cluster;
230         struct completion started;
231 };
232
233 static struct bL_thread bL_threads[NR_CPUS];
234
235 static int bL_switcher_thread(void *arg)
236 {
237         struct bL_thread *t = arg;
238         struct sched_param param = { .sched_priority = 1 };
239         int cluster;
240
241         sched_setscheduler_nocheck(current, SCHED_FIFO, &param);
242         complete(&t->started);
243
244         do {
245                 if (signal_pending(current))
246                         flush_signals(current);
247                 wait_event_interruptible(t->wq,
248                                 t->wanted_cluster != -1 ||
249                                 kthread_should_stop());
250                 cluster = xchg(&t->wanted_cluster, -1);
251                 if (cluster != -1)
252                         bL_switch_to(cluster);
253         } while (!kthread_should_stop());
254
255         return 0;
256 }
257
258 static struct task_struct *bL_switcher_thread_create(int cpu, void *arg)
259 {
260         struct task_struct *task;
261
262         task = kthread_create_on_node(bL_switcher_thread, arg,
263                                       cpu_to_node(cpu), "kswitcher_%d", cpu);
264         if (!IS_ERR(task)) {
265                 kthread_bind(task, cpu);
266                 wake_up_process(task);
267         } else
268                 pr_err("%s failed for CPU %d\n", __func__, cpu);
269         return task;
270 }
271
272 /*
273  * bL_switch_request - Switch to a specific cluster for the given CPU
274  *
275  * @cpu: the CPU to switch
276  * @new_cluster_id: the ID of the cluster to switch to.
277  *
278  * This function causes a cluster switch on the given CPU by waking up
279  * the appropriate switcher thread.  This function may or may not return
280  * before the switch has occurred.
281  */
282 int bL_switch_request(unsigned int cpu, unsigned int new_cluster_id)
283 {
284         struct bL_thread *t;
285
286         if (cpu >= ARRAY_SIZE(bL_threads)) {
287                 pr_err("%s: cpu %d out of bounds\n", __func__, cpu);
288                 return -EINVAL;
289         }
290
291         t = &bL_threads[cpu];
292         if (IS_ERR(t->task))
293                 return PTR_ERR(t->task);
294         if (!t->task)
295                 return -ESRCH;
296
297         t->wanted_cluster = new_cluster_id;
298         wake_up(&t->wq);
299         return 0;
300 }
301 EXPORT_SYMBOL_GPL(bL_switch_request);
302
303 /*
304  * Activation and configuration code.
305  */
306
307 static DEFINE_MUTEX(bL_switcher_activation_lock);
308 static BLOCKING_NOTIFIER_HEAD(bL_activation_notifier);
309 static unsigned int bL_switcher_active;
310 static unsigned int bL_switcher_cpu_original_cluster[NR_CPUS];
311 static cpumask_t bL_switcher_removed_logical_cpus;
312
313 int bL_switcher_register_notifier(struct notifier_block *nb)
314 {
315         return blocking_notifier_chain_register(&bL_activation_notifier, nb);
316 }
317 EXPORT_SYMBOL_GPL(bL_switcher_register_notifier);
318
319 int bL_switcher_unregister_notifier(struct notifier_block *nb)
320 {
321         return blocking_notifier_chain_unregister(&bL_activation_notifier, nb);
322 }
323 EXPORT_SYMBOL_GPL(bL_switcher_unregister_notifier);
324
325 static int bL_activation_notify(unsigned long val)
326 {
327         int ret;
328
329         ret = blocking_notifier_call_chain(&bL_activation_notifier, val, NULL);
330         if (ret & NOTIFY_STOP_MASK)
331                 pr_err("%s: notifier chain failed with status 0x%x\n",
332                         __func__, ret);
333         return notifier_to_errno(ret);
334 }
335
336 static void bL_switcher_restore_cpus(void)
337 {
338         int i;
339
340         for_each_cpu(i, &bL_switcher_removed_logical_cpus)
341                 cpu_up(i);
342 }
343
344 static int bL_switcher_halve_cpus(void)
345 {
346         int i, j, cluster_0, gic_id, ret;
347         unsigned int cpu, cluster, mask;
348         cpumask_t available_cpus;
349
350         /* First pass to validate what we have */
351         mask = 0;
352         for_each_online_cpu(i) {
353                 cpu = MPIDR_AFFINITY_LEVEL(cpu_logical_map(i), 0);
354                 cluster = MPIDR_AFFINITY_LEVEL(cpu_logical_map(i), 1);
355                 if (cluster >= 2) {
356                         pr_err("%s: only dual cluster systems are supported\n", __func__);
357                         return -EINVAL;
358                 }
359                 if (WARN_ON(cpu >= MAX_CPUS_PER_CLUSTER))
360                         return -EINVAL;
361                 mask |= (1 << cluster);
362         }
363         if (mask != 3) {
364                 pr_err("%s: no CPU pairing possible\n", __func__);
365                 return -EINVAL;
366         }
367
368         /*
369          * Now let's do the pairing.  We match each CPU with another CPU
370          * from a different cluster.  To get a uniform scheduling behavior
371          * without fiddling with CPU topology and compute capacity data,
372          * we'll use logical CPUs initially belonging to the same cluster.
373          */
374         memset(bL_switcher_cpu_pairing, -1, sizeof(bL_switcher_cpu_pairing));
375         cpumask_copy(&available_cpus, cpu_online_mask);
376         cluster_0 = -1;
377         for_each_cpu(i, &available_cpus) {
378                 int match = -1;
379                 cluster = MPIDR_AFFINITY_LEVEL(cpu_logical_map(i), 1);
380                 if (cluster_0 == -1)
381                         cluster_0 = cluster;
382                 if (cluster != cluster_0)
383                         continue;
384                 cpumask_clear_cpu(i, &available_cpus);
385                 for_each_cpu(j, &available_cpus) {
386                         cluster = MPIDR_AFFINITY_LEVEL(cpu_logical_map(j), 1);
387                         /*
388                          * Let's remember the last match to create "odd"
389                          * pairings on purpose in order for other code not
390                          * to assume any relation between physical and
391                          * logical CPU numbers.
392                          */
393                         if (cluster != cluster_0)
394                                 match = j;
395                 }
396                 if (match != -1) {
397                         bL_switcher_cpu_pairing[i] = match;
398                         cpumask_clear_cpu(match, &available_cpus);
399                         pr_info("CPU%d paired with CPU%d\n", i, match);
400                 }
401         }
402
403         /*
404          * Now we disable the unwanted CPUs i.e. everything that has no
405          * pairing information (that includes the pairing counterparts).
406          */
407         cpumask_clear(&bL_switcher_removed_logical_cpus);
408         for_each_online_cpu(i) {
409                 cpu = MPIDR_AFFINITY_LEVEL(cpu_logical_map(i), 0);
410                 cluster = MPIDR_AFFINITY_LEVEL(cpu_logical_map(i), 1);
411
412                 /* Let's take note of the GIC ID for this CPU */
413                 gic_id = gic_get_cpu_id(i);
414                 if (gic_id < 0) {
415                         pr_err("%s: bad GIC ID for CPU %d\n", __func__, i);
416                         bL_switcher_restore_cpus();
417                         return -EINVAL;
418                 }
419                 bL_gic_id[cpu][cluster] = gic_id;
420                 pr_info("GIC ID for CPU %u cluster %u is %u\n",
421                         cpu, cluster, gic_id);
422
423                 if (bL_switcher_cpu_pairing[i] != -1) {
424                         bL_switcher_cpu_original_cluster[i] = cluster;
425                         continue;
426                 }
427
428                 ret = cpu_down(i);
429                 if (ret) {
430                         bL_switcher_restore_cpus();
431                         return ret;
432                 }
433                 cpumask_set_cpu(i, &bL_switcher_removed_logical_cpus);
434         }
435
436         return 0;
437 }
438
439 static int bL_switcher_enable(void)
440 {
441         int cpu, ret;
442
443         mutex_lock(&bL_switcher_activation_lock);
444         cpu_hotplug_driver_lock();
445         if (bL_switcher_active) {
446                 cpu_hotplug_driver_unlock();
447                 mutex_unlock(&bL_switcher_activation_lock);
448                 return 0;
449         }
450
451         pr_info("big.LITTLE switcher initializing\n");
452
453         ret = bL_activation_notify(BL_NOTIFY_PRE_ENABLE);
454         if (ret)
455                 goto error;
456
457         ret = bL_switcher_halve_cpus();
458         if (ret)
459                 goto error;
460
461         for_each_online_cpu(cpu) {
462                 struct bL_thread *t = &bL_threads[cpu];
463                 init_waitqueue_head(&t->wq);
464                 init_completion(&t->started);
465                 t->wanted_cluster = -1;
466                 t->task = bL_switcher_thread_create(cpu, t);
467         }
468
469         bL_switcher_active = 1;
470         bL_activation_notify(BL_NOTIFY_POST_ENABLE);
471         pr_info("big.LITTLE switcher initialized\n");
472         goto out;
473
474 error:
475         pr_warn("big.LITTLE switcher initialization failed\n");
476         bL_activation_notify(BL_NOTIFY_POST_DISABLE);
477
478 out:
479         cpu_hotplug_driver_unlock();
480         mutex_unlock(&bL_switcher_activation_lock);
481         return ret;
482 }
483
484 #ifdef CONFIG_SYSFS
485
486 static void bL_switcher_disable(void)
487 {
488         unsigned int cpu, cluster;
489         struct bL_thread *t;
490         struct task_struct *task;
491
492         mutex_lock(&bL_switcher_activation_lock);
493         cpu_hotplug_driver_lock();
494
495         if (!bL_switcher_active)
496                 goto out;
497
498         if (bL_activation_notify(BL_NOTIFY_PRE_DISABLE) != 0) {
499                 bL_activation_notify(BL_NOTIFY_POST_ENABLE);
500                 goto out;
501         }
502
503         bL_switcher_active = 0;
504
505         /*
506          * To deactivate the switcher, we must shut down the switcher
507          * threads to prevent any other requests from being accepted.
508          * Then, if the final cluster for given logical CPU is not the
509          * same as the original one, we'll recreate a switcher thread
510          * just for the purpose of switching the CPU back without any
511          * possibility for interference from external requests.
512          */
513         for_each_online_cpu(cpu) {
514                 t = &bL_threads[cpu];
515                 task = t->task;
516                 t->task = NULL;
517                 if (!task || IS_ERR(task))
518                         continue;
519                 kthread_stop(task);
520                 /* no more switch may happen on this CPU at this point */
521                 cluster = MPIDR_AFFINITY_LEVEL(cpu_logical_map(cpu), 1);
522                 if (cluster == bL_switcher_cpu_original_cluster[cpu])
523                         continue;
524                 init_completion(&t->started);
525                 t->wanted_cluster = bL_switcher_cpu_original_cluster[cpu];
526                 task = bL_switcher_thread_create(cpu, t);
527                 if (!IS_ERR(task)) {
528                         wait_for_completion(&t->started);
529                         kthread_stop(task);
530                         cluster = MPIDR_AFFINITY_LEVEL(cpu_logical_map(cpu), 1);
531                         if (cluster == bL_switcher_cpu_original_cluster[cpu])
532                                 continue;
533                 }
534                 /* If execution gets here, we're in trouble. */
535                 pr_crit("%s: unable to restore original cluster for CPU %d\n",
536                         __func__, cpu);
537                 pr_crit("%s: CPU %d can't be restored\n",
538                         __func__, bL_switcher_cpu_pairing[cpu]);
539                 cpumask_clear_cpu(bL_switcher_cpu_pairing[cpu],
540                                   &bL_switcher_removed_logical_cpus);
541         }
542
543         bL_switcher_restore_cpus();
544         bL_activation_notify(BL_NOTIFY_POST_DISABLE);
545
546 out:
547         cpu_hotplug_driver_unlock();
548         mutex_unlock(&bL_switcher_activation_lock);
549 }
550
551 static ssize_t bL_switcher_active_show(struct kobject *kobj,
552                 struct kobj_attribute *attr, char *buf)
553 {
554         return sprintf(buf, "%u\n", bL_switcher_active);
555 }
556
557 static ssize_t bL_switcher_active_store(struct kobject *kobj,
558                 struct kobj_attribute *attr, const char *buf, size_t count)
559 {
560         int ret;
561
562         switch (buf[0]) {
563         case '0':
564                 bL_switcher_disable();
565                 ret = 0;
566                 break;
567         case '1':
568                 ret = bL_switcher_enable();
569                 break;
570         default:
571                 ret = -EINVAL;
572         }
573
574         return (ret >= 0) ? count : ret;
575 }
576
577 static struct kobj_attribute bL_switcher_active_attr =
578         __ATTR(active, 0644, bL_switcher_active_show, bL_switcher_active_store);
579
580 static struct attribute *bL_switcher_attrs[] = {
581         &bL_switcher_active_attr.attr,
582         NULL,
583 };
584
585 static struct attribute_group bL_switcher_attr_group = {
586         .attrs = bL_switcher_attrs,
587 };
588
589 static struct kobject *bL_switcher_kobj;
590
591 static int __init bL_switcher_sysfs_init(void)
592 {
593         int ret;
594
595         bL_switcher_kobj = kobject_create_and_add("bL_switcher", kernel_kobj);
596         if (!bL_switcher_kobj)
597                 return -ENOMEM;
598         ret = sysfs_create_group(bL_switcher_kobj, &bL_switcher_attr_group);
599         if (ret)
600                 kobject_put(bL_switcher_kobj);
601         return ret;
602 }
603
604 #endif  /* CONFIG_SYSFS */
605
606 bool bL_switcher_get_enabled(void)
607 {
608         mutex_lock(&bL_switcher_activation_lock);
609
610         return bL_switcher_active;
611 }
612 EXPORT_SYMBOL_GPL(bL_switcher_get_enabled);
613
614 void bL_switcher_put_enabled(void)
615 {
616         mutex_unlock(&bL_switcher_activation_lock);
617 }
618 EXPORT_SYMBOL_GPL(bL_switcher_put_enabled);
619
620 /*
621  * Veto any CPU hotplug operation on those CPUs we've removed
622  * while the switcher is active.
623  * We're just not ready to deal with that given the trickery involved.
624  */
625 static int bL_switcher_hotplug_callback(struct notifier_block *nfb,
626                                         unsigned long action, void *hcpu)
627 {
628         if (bL_switcher_active) {
629                 int pairing = bL_switcher_cpu_pairing[(unsigned long)hcpu];
630                 switch (action & 0xf) {
631                 case CPU_UP_PREPARE:
632                 case CPU_DOWN_PREPARE:
633                         if (pairing == -1)
634                                 return NOTIFY_BAD;
635                 }
636         }
637         return NOTIFY_DONE;
638 }
639
640 static bool no_bL_switcher;
641 core_param(no_bL_switcher, no_bL_switcher, bool, 0644);
642
643 static int __init bL_switcher_init(void)
644 {
645         int ret;
646
647         if (MAX_NR_CLUSTERS != 2) {
648                 pr_err("%s: only dual cluster systems are supported\n", __func__);
649                 return -EINVAL;
650         }
651
652         cpu_notifier(bL_switcher_hotplug_callback, 0);
653
654         if (!no_bL_switcher) {
655                 ret = bL_switcher_enable();
656                 if (ret)
657                         return ret;
658         }
659
660 #ifdef CONFIG_SYSFS
661         ret = bL_switcher_sysfs_init();
662         if (ret)
663                 pr_err("%s: unable to create sysfs entry\n", __func__);
664 #endif
665
666         return 0;
667 }
668
669 late_initcall(bL_switcher_init);