firmware/psci: Expose PSCI conduit
[sfrench/cifs-2.6.git] / drivers / firmware / psci.c
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License version 2 as
4  * published by the Free Software Foundation.
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9  * GNU General Public License for more details.
10  *
11  * Copyright (C) 2015 ARM Limited
12  */
13
14 #define pr_fmt(fmt) "psci: " fmt
15
16 #include <linux/acpi.h>
17 #include <linux/arm-smccc.h>
18 #include <linux/cpuidle.h>
19 #include <linux/errno.h>
20 #include <linux/linkage.h>
21 #include <linux/of.h>
22 #include <linux/pm.h>
23 #include <linux/printk.h>
24 #include <linux/psci.h>
25 #include <linux/reboot.h>
26 #include <linux/slab.h>
27 #include <linux/suspend.h>
28
29 #include <uapi/linux/psci.h>
30
31 #include <asm/cpuidle.h>
32 #include <asm/cputype.h>
33 #include <asm/system_misc.h>
34 #include <asm/smp_plat.h>
35 #include <asm/suspend.h>
36
37 /*
38  * While a 64-bit OS can make calls with SMC32 calling conventions, for some
39  * calls it is necessary to use SMC64 to pass or return 64-bit values.
40  * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
41  * (native-width) function ID.
42  */
43 #ifdef CONFIG_64BIT
44 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN64_##name
45 #else
46 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN_##name
47 #endif
48
49 /*
50  * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
51  * calls to its resident CPU, so we must avoid issuing those. We never migrate
52  * a Trusted OS even if it claims to be capable of migration -- doing so will
53  * require cooperation with a Trusted OS driver.
54  */
55 static int resident_cpu = -1;
56
57 bool psci_tos_resident_on(int cpu)
58 {
59         return cpu == resident_cpu;
60 }
61
62 struct psci_operations psci_ops = {
63         .conduit = PSCI_CONDUIT_NONE,
64 };
65
66 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
67                                 unsigned long, unsigned long);
68 static psci_fn *invoke_psci_fn;
69
70 enum psci_function {
71         PSCI_FN_CPU_SUSPEND,
72         PSCI_FN_CPU_ON,
73         PSCI_FN_CPU_OFF,
74         PSCI_FN_MIGRATE,
75         PSCI_FN_MAX,
76 };
77
78 static u32 psci_function_id[PSCI_FN_MAX];
79
80 #define PSCI_0_2_POWER_STATE_MASK               \
81                                 (PSCI_0_2_POWER_STATE_ID_MASK | \
82                                 PSCI_0_2_POWER_STATE_TYPE_MASK | \
83                                 PSCI_0_2_POWER_STATE_AFFL_MASK)
84
85 #define PSCI_1_0_EXT_POWER_STATE_MASK           \
86                                 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
87                                 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
88
89 static u32 psci_cpu_suspend_feature;
90
91 static inline bool psci_has_ext_power_state(void)
92 {
93         return psci_cpu_suspend_feature &
94                                 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
95 }
96
97 static inline bool psci_power_state_loses_context(u32 state)
98 {
99         const u32 mask = psci_has_ext_power_state() ?
100                                         PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
101                                         PSCI_0_2_POWER_STATE_TYPE_MASK;
102
103         return state & mask;
104 }
105
106 static inline bool psci_power_state_is_valid(u32 state)
107 {
108         const u32 valid_mask = psci_has_ext_power_state() ?
109                                PSCI_1_0_EXT_POWER_STATE_MASK :
110                                PSCI_0_2_POWER_STATE_MASK;
111
112         return !(state & ~valid_mask);
113 }
114
115 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
116                         unsigned long arg0, unsigned long arg1,
117                         unsigned long arg2)
118 {
119         struct arm_smccc_res res;
120
121         arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
122         return res.a0;
123 }
124
125 static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
126                         unsigned long arg0, unsigned long arg1,
127                         unsigned long arg2)
128 {
129         struct arm_smccc_res res;
130
131         arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
132         return res.a0;
133 }
134
135 static int psci_to_linux_errno(int errno)
136 {
137         switch (errno) {
138         case PSCI_RET_SUCCESS:
139                 return 0;
140         case PSCI_RET_NOT_SUPPORTED:
141                 return -EOPNOTSUPP;
142         case PSCI_RET_INVALID_PARAMS:
143         case PSCI_RET_INVALID_ADDRESS:
144                 return -EINVAL;
145         case PSCI_RET_DENIED:
146                 return -EPERM;
147         };
148
149         return -EINVAL;
150 }
151
152 static u32 psci_get_version(void)
153 {
154         return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
155 }
156
157 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
158 {
159         int err;
160         u32 fn;
161
162         fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
163         err = invoke_psci_fn(fn, state, entry_point, 0);
164         return psci_to_linux_errno(err);
165 }
166
167 static int psci_cpu_off(u32 state)
168 {
169         int err;
170         u32 fn;
171
172         fn = psci_function_id[PSCI_FN_CPU_OFF];
173         err = invoke_psci_fn(fn, state, 0, 0);
174         return psci_to_linux_errno(err);
175 }
176
177 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
178 {
179         int err;
180         u32 fn;
181
182         fn = psci_function_id[PSCI_FN_CPU_ON];
183         err = invoke_psci_fn(fn, cpuid, entry_point, 0);
184         return psci_to_linux_errno(err);
185 }
186
187 static int psci_migrate(unsigned long cpuid)
188 {
189         int err;
190         u32 fn;
191
192         fn = psci_function_id[PSCI_FN_MIGRATE];
193         err = invoke_psci_fn(fn, cpuid, 0, 0);
194         return psci_to_linux_errno(err);
195 }
196
197 static int psci_affinity_info(unsigned long target_affinity,
198                 unsigned long lowest_affinity_level)
199 {
200         return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
201                               target_affinity, lowest_affinity_level, 0);
202 }
203
204 static int psci_migrate_info_type(void)
205 {
206         return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
207 }
208
209 static unsigned long psci_migrate_info_up_cpu(void)
210 {
211         return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
212                               0, 0, 0);
213 }
214
215 static void set_conduit(enum psci_conduit conduit)
216 {
217         switch (conduit) {
218         case PSCI_CONDUIT_HVC:
219                 invoke_psci_fn = __invoke_psci_fn_hvc;
220                 break;
221         case PSCI_CONDUIT_SMC:
222                 invoke_psci_fn = __invoke_psci_fn_smc;
223                 break;
224         default:
225                 WARN(1, "Unexpected PSCI conduit %d\n", conduit);
226         }
227
228         psci_ops.conduit = conduit;
229 }
230
231 static int get_set_conduit_method(struct device_node *np)
232 {
233         const char *method;
234
235         pr_info("probing for conduit method from DT.\n");
236
237         if (of_property_read_string(np, "method", &method)) {
238                 pr_warn("missing \"method\" property\n");
239                 return -ENXIO;
240         }
241
242         if (!strcmp("hvc", method)) {
243                 set_conduit(PSCI_CONDUIT_HVC);
244         } else if (!strcmp("smc", method)) {
245                 set_conduit(PSCI_CONDUIT_SMC);
246         } else {
247                 pr_warn("invalid \"method\" property: %s\n", method);
248                 return -EINVAL;
249         }
250         return 0;
251 }
252
253 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
254 {
255         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
256 }
257
258 static void psci_sys_poweroff(void)
259 {
260         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
261 }
262
263 static int __init psci_features(u32 psci_func_id)
264 {
265         return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
266                               psci_func_id, 0, 0);
267 }
268
269 #ifdef CONFIG_CPU_IDLE
270 static DEFINE_PER_CPU_READ_MOSTLY(u32 *, psci_power_state);
271
272 static int psci_dt_cpu_init_idle(struct device_node *cpu_node, int cpu)
273 {
274         int i, ret, count = 0;
275         u32 *psci_states;
276         struct device_node *state_node;
277
278         /* Count idle states */
279         while ((state_node = of_parse_phandle(cpu_node, "cpu-idle-states",
280                                               count))) {
281                 count++;
282                 of_node_put(state_node);
283         }
284
285         if (!count)
286                 return -ENODEV;
287
288         psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
289         if (!psci_states)
290                 return -ENOMEM;
291
292         for (i = 0; i < count; i++) {
293                 u32 state;
294
295                 state_node = of_parse_phandle(cpu_node, "cpu-idle-states", i);
296
297                 ret = of_property_read_u32(state_node,
298                                            "arm,psci-suspend-param",
299                                            &state);
300                 if (ret) {
301                         pr_warn(" * %pOF missing arm,psci-suspend-param property\n",
302                                 state_node);
303                         of_node_put(state_node);
304                         goto free_mem;
305                 }
306
307                 of_node_put(state_node);
308                 pr_debug("psci-power-state %#x index %d\n", state, i);
309                 if (!psci_power_state_is_valid(state)) {
310                         pr_warn("Invalid PSCI power state %#x\n", state);
311                         ret = -EINVAL;
312                         goto free_mem;
313                 }
314                 psci_states[i] = state;
315         }
316         /* Idle states parsed correctly, initialize per-cpu pointer */
317         per_cpu(psci_power_state, cpu) = psci_states;
318         return 0;
319
320 free_mem:
321         kfree(psci_states);
322         return ret;
323 }
324
325 #ifdef CONFIG_ACPI
326 #include <acpi/processor.h>
327
328 static int __maybe_unused psci_acpi_cpu_init_idle(unsigned int cpu)
329 {
330         int i, count;
331         u32 *psci_states;
332         struct acpi_lpi_state *lpi;
333         struct acpi_processor *pr = per_cpu(processors, cpu);
334
335         if (unlikely(!pr || !pr->flags.has_lpi))
336                 return -EINVAL;
337
338         count = pr->power.count - 1;
339         if (count <= 0)
340                 return -ENODEV;
341
342         psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
343         if (!psci_states)
344                 return -ENOMEM;
345
346         for (i = 0; i < count; i++) {
347                 u32 state;
348
349                 lpi = &pr->power.lpi_states[i + 1];
350                 /*
351                  * Only bits[31:0] represent a PSCI power_state while
352                  * bits[63:32] must be 0x0 as per ARM ACPI FFH Specification
353                  */
354                 state = lpi->address;
355                 if (!psci_power_state_is_valid(state)) {
356                         pr_warn("Invalid PSCI power state %#x\n", state);
357                         kfree(psci_states);
358                         return -EINVAL;
359                 }
360                 psci_states[i] = state;
361         }
362         /* Idle states parsed correctly, initialize per-cpu pointer */
363         per_cpu(psci_power_state, cpu) = psci_states;
364         return 0;
365 }
366 #else
367 static int __maybe_unused psci_acpi_cpu_init_idle(unsigned int cpu)
368 {
369         return -EINVAL;
370 }
371 #endif
372
373 int psci_cpu_init_idle(unsigned int cpu)
374 {
375         struct device_node *cpu_node;
376         int ret;
377
378         /*
379          * If the PSCI cpu_suspend function hook has not been initialized
380          * idle states must not be enabled, so bail out
381          */
382         if (!psci_ops.cpu_suspend)
383                 return -EOPNOTSUPP;
384
385         if (!acpi_disabled)
386                 return psci_acpi_cpu_init_idle(cpu);
387
388         cpu_node = of_get_cpu_node(cpu, NULL);
389         if (!cpu_node)
390                 return -ENODEV;
391
392         ret = psci_dt_cpu_init_idle(cpu_node, cpu);
393
394         of_node_put(cpu_node);
395
396         return ret;
397 }
398
399 static int psci_suspend_finisher(unsigned long index)
400 {
401         u32 *state = __this_cpu_read(psci_power_state);
402
403         return psci_ops.cpu_suspend(state[index - 1],
404                                     __pa_symbol(cpu_resume));
405 }
406
407 int psci_cpu_suspend_enter(unsigned long index)
408 {
409         int ret;
410         u32 *state = __this_cpu_read(psci_power_state);
411         /*
412          * idle state index 0 corresponds to wfi, should never be called
413          * from the cpu_suspend operations
414          */
415         if (WARN_ON_ONCE(!index))
416                 return -EINVAL;
417
418         if (!psci_power_state_loses_context(state[index - 1]))
419                 ret = psci_ops.cpu_suspend(state[index - 1], 0);
420         else
421                 ret = cpu_suspend(index, psci_suspend_finisher);
422
423         return ret;
424 }
425
426 /* ARM specific CPU idle operations */
427 #ifdef CONFIG_ARM
428 static const struct cpuidle_ops psci_cpuidle_ops __initconst = {
429         .suspend = psci_cpu_suspend_enter,
430         .init = psci_dt_cpu_init_idle,
431 };
432
433 CPUIDLE_METHOD_OF_DECLARE(psci, "psci", &psci_cpuidle_ops);
434 #endif
435 #endif
436
437 static int psci_system_suspend(unsigned long unused)
438 {
439         return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
440                               __pa_symbol(cpu_resume), 0, 0);
441 }
442
443 static int psci_system_suspend_enter(suspend_state_t state)
444 {
445         return cpu_suspend(0, psci_system_suspend);
446 }
447
448 static const struct platform_suspend_ops psci_suspend_ops = {
449         .valid          = suspend_valid_only_mem,
450         .enter          = psci_system_suspend_enter,
451 };
452
453 static void __init psci_init_system_suspend(void)
454 {
455         int ret;
456
457         if (!IS_ENABLED(CONFIG_SUSPEND))
458                 return;
459
460         ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
461
462         if (ret != PSCI_RET_NOT_SUPPORTED)
463                 suspend_set_ops(&psci_suspend_ops);
464 }
465
466 static void __init psci_init_cpu_suspend(void)
467 {
468         int feature = psci_features(psci_function_id[PSCI_FN_CPU_SUSPEND]);
469
470         if (feature != PSCI_RET_NOT_SUPPORTED)
471                 psci_cpu_suspend_feature = feature;
472 }
473
474 /*
475  * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
476  * return DENIED (which would be fatal).
477  */
478 static void __init psci_init_migrate(void)
479 {
480         unsigned long cpuid;
481         int type, cpu = -1;
482
483         type = psci_ops.migrate_info_type();
484
485         if (type == PSCI_0_2_TOS_MP) {
486                 pr_info("Trusted OS migration not required\n");
487                 return;
488         }
489
490         if (type == PSCI_RET_NOT_SUPPORTED) {
491                 pr_info("MIGRATE_INFO_TYPE not supported.\n");
492                 return;
493         }
494
495         if (type != PSCI_0_2_TOS_UP_MIGRATE &&
496             type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
497                 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
498                 return;
499         }
500
501         cpuid = psci_migrate_info_up_cpu();
502         if (cpuid & ~MPIDR_HWID_BITMASK) {
503                 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
504                         cpuid);
505                 return;
506         }
507
508         cpu = get_logical_index(cpuid);
509         resident_cpu = cpu >= 0 ? cpu : -1;
510
511         pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
512 }
513
514 static void __init psci_0_2_set_functions(void)
515 {
516         pr_info("Using standard PSCI v0.2 function IDs\n");
517         psci_ops.get_version = psci_get_version;
518
519         psci_function_id[PSCI_FN_CPU_SUSPEND] =
520                                         PSCI_FN_NATIVE(0_2, CPU_SUSPEND);
521         psci_ops.cpu_suspend = psci_cpu_suspend;
522
523         psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
524         psci_ops.cpu_off = psci_cpu_off;
525
526         psci_function_id[PSCI_FN_CPU_ON] = PSCI_FN_NATIVE(0_2, CPU_ON);
527         psci_ops.cpu_on = psci_cpu_on;
528
529         psci_function_id[PSCI_FN_MIGRATE] = PSCI_FN_NATIVE(0_2, MIGRATE);
530         psci_ops.migrate = psci_migrate;
531
532         psci_ops.affinity_info = psci_affinity_info;
533
534         psci_ops.migrate_info_type = psci_migrate_info_type;
535
536         arm_pm_restart = psci_sys_reset;
537
538         pm_power_off = psci_sys_poweroff;
539 }
540
541 /*
542  * Probe function for PSCI firmware versions >= 0.2
543  */
544 static int __init psci_probe(void)
545 {
546         u32 ver = psci_get_version();
547
548         pr_info("PSCIv%d.%d detected in firmware.\n",
549                         PSCI_VERSION_MAJOR(ver),
550                         PSCI_VERSION_MINOR(ver));
551
552         if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
553                 pr_err("Conflicting PSCI version detected.\n");
554                 return -EINVAL;
555         }
556
557         psci_0_2_set_functions();
558
559         psci_init_migrate();
560
561         if (PSCI_VERSION_MAJOR(ver) >= 1) {
562                 psci_init_cpu_suspend();
563                 psci_init_system_suspend();
564         }
565
566         return 0;
567 }
568
569 typedef int (*psci_initcall_t)(const struct device_node *);
570
571 /*
572  * PSCI init function for PSCI versions >=0.2
573  *
574  * Probe based on PSCI PSCI_VERSION function
575  */
576 static int __init psci_0_2_init(struct device_node *np)
577 {
578         int err;
579
580         err = get_set_conduit_method(np);
581
582         if (err)
583                 goto out_put_node;
584         /*
585          * Starting with v0.2, the PSCI specification introduced a call
586          * (PSCI_VERSION) that allows probing the firmware version, so
587          * that PSCI function IDs and version specific initialization
588          * can be carried out according to the specific version reported
589          * by firmware
590          */
591         err = psci_probe();
592
593 out_put_node:
594         of_node_put(np);
595         return err;
596 }
597
598 /*
599  * PSCI < v0.2 get PSCI Function IDs via DT.
600  */
601 static int __init psci_0_1_init(struct device_node *np)
602 {
603         u32 id;
604         int err;
605
606         err = get_set_conduit_method(np);
607
608         if (err)
609                 goto out_put_node;
610
611         pr_info("Using PSCI v0.1 Function IDs from DT\n");
612
613         if (!of_property_read_u32(np, "cpu_suspend", &id)) {
614                 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
615                 psci_ops.cpu_suspend = psci_cpu_suspend;
616         }
617
618         if (!of_property_read_u32(np, "cpu_off", &id)) {
619                 psci_function_id[PSCI_FN_CPU_OFF] = id;
620                 psci_ops.cpu_off = psci_cpu_off;
621         }
622
623         if (!of_property_read_u32(np, "cpu_on", &id)) {
624                 psci_function_id[PSCI_FN_CPU_ON] = id;
625                 psci_ops.cpu_on = psci_cpu_on;
626         }
627
628         if (!of_property_read_u32(np, "migrate", &id)) {
629                 psci_function_id[PSCI_FN_MIGRATE] = id;
630                 psci_ops.migrate = psci_migrate;
631         }
632
633 out_put_node:
634         of_node_put(np);
635         return err;
636 }
637
638 static const struct of_device_id psci_of_match[] __initconst = {
639         { .compatible = "arm,psci",     .data = psci_0_1_init},
640         { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
641         { .compatible = "arm,psci-1.0", .data = psci_0_2_init},
642         {},
643 };
644
645 int __init psci_dt_init(void)
646 {
647         struct device_node *np;
648         const struct of_device_id *matched_np;
649         psci_initcall_t init_fn;
650
651         np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
652
653         if (!np || !of_device_is_available(np))
654                 return -ENODEV;
655
656         init_fn = (psci_initcall_t)matched_np->data;
657         return init_fn(np);
658 }
659
660 #ifdef CONFIG_ACPI
661 /*
662  * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
663  * explicitly clarified in SBBR
664  */
665 int __init psci_acpi_init(void)
666 {
667         if (!acpi_psci_present()) {
668                 pr_info("is not implemented in ACPI.\n");
669                 return -EOPNOTSUPP;
670         }
671
672         pr_info("probing for conduit method from ACPI.\n");
673
674         if (acpi_psci_use_hvc())
675                 set_conduit(PSCI_CONDUIT_HVC);
676         else
677                 set_conduit(PSCI_CONDUIT_SMC);
678
679         return psci_probe();
680 }
681 #endif