1 /*-
2 * Copyright (c) 2013, 2014 Robin Randhawa
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27 #ifndef _MACHINE_PSCI_H_
28 #define _MACHINE_PSCI_H_
29
30 #include <sys/types.h>
31 #include <dev/psci/smccc.h>
32
33 #ifdef _KERNEL
34 typedef int (*psci_initfn_t)(device_t dev, int default_version);
35 typedef int (*psci_callfn_t)(register_t, register_t, register_t, register_t,
36 register_t, register_t, register_t, register_t,
37 struct arm_smccc_res *res);
38
39 extern bool psci_present;
40
41 int psci_cpu_on(unsigned long, unsigned long, unsigned long);
42 void psci_reset(void);
43 int32_t psci_features(uint32_t);
44 int psci_get_version(void);
45
46 /* Handler to let us call into the PSCI/SMCCC firmware */
47 extern psci_callfn_t psci_callfn;
48 static inline int
psci_call(register_t a,register_t b,register_t c,register_t d)49 psci_call(register_t a, register_t b, register_t c, register_t d)
50 {
51
52 return (psci_callfn(a, b, c, d, 0, 0, 0, 0, NULL));
53 }
54 #endif
55
56 /*
57 * PSCI return codes.
58 */
59 #define PSCI_RETVAL_SUCCESS 0
60 #define PSCI_RETVAL_NOT_SUPPORTED -1
61 #define PSCI_RETVAL_INVALID_PARAMS -2
62 #define PSCI_RETVAL_DENIED -3
63 #define PSCI_RETVAL_ALREADY_ON -4
64 #define PSCI_RETVAL_ON_PENDING -5
65 #define PSCI_RETVAL_INTERNAL_FAILURE -6
66 #define PSCI_RETVAL_NOT_PRESENT -7
67 #define PSCI_RETVAL_DISABLED -8
68 /*
69 * Used to signal PSCI is not available, e.g. to start a CPU.
70 */
71 #define PSCI_MISSING 1
72
73 /*
74 * PSCI function codes (as per PSCI v0.2).
75 */
76 #ifdef __aarch64__
77 #define PSCI_FNID_VERSION 0x84000000
78 #define PSCI_FNID_CPU_SUSPEND 0xc4000001
79 #define PSCI_FNID_CPU_OFF 0x84000002
80 #define PSCI_FNID_CPU_ON 0xc4000003
81 #define PSCI_FNID_AFFINITY_INFO 0xc4000004
82 #define PSCI_FNID_MIGRATE 0xc4000005
83 #define PSCI_FNID_MIGRATE_INFO_TYPE 0x84000006
84 #define PSCI_FNID_MIGRATE_INFO_UP_CPU 0xc4000007
85 #define PSCI_FNID_SYSTEM_OFF 0x84000008
86 #define PSCI_FNID_SYSTEM_RESET 0x84000009
87 #define PSCI_FNID_FEATURES 0x8400000a
88 #else
89 #define PSCI_FNID_VERSION 0x84000000
90 #define PSCI_FNID_CPU_SUSPEND 0x84000001
91 #define PSCI_FNID_CPU_OFF 0x84000002
92 #define PSCI_FNID_CPU_ON 0x84000003
93 #define PSCI_FNID_AFFINITY_INFO 0x84000004
94 #define PSCI_FNID_MIGRATE 0x84000005
95 #define PSCI_FNID_MIGRATE_INFO_TYPE 0x84000006
96 #define PSCI_FNID_MIGRATE_INFO_UP_CPU 0x84000007
97 #define PSCI_FNID_SYSTEM_OFF 0x84000008
98 #define PSCI_FNID_SYSTEM_RESET 0x84000009
99 #define PSCI_FNID_FEATURES 0x8400000a
100 #endif
101
102 #define PSCI_VER_MAJOR(v) (((v) >> 16) & 0xFF)
103 #define PSCI_VER_MINOR(v) ((v) & 0xFF)
104 #define PSCI_VER(maj, min) (((maj) << 16) | (min))
105
106 #define PSCI_AFFINITY_INFO_ON 0
107 #define PSCI_AFFINITY_INFO_OFF 1
108 #define PSCI_AFFINITY_INFO_ON_PENDING 2
109
110 #ifdef _KERNEL
111 enum psci_fn {
112 PSCI_FN_VERSION,
113 PSCI_FN_CPU_SUSPEND,
114 PSCI_FN_CPU_OFF,
115 PSCI_FN_CPU_ON,
116 PSCI_FN_AFFINITY_INFO,
117 PSCI_FN_MIGRATE,
118 PSCI_FN_MIGRATE_INFO_TYPE,
119 PSCI_FN_MIGRATE_INFO_UP_CPU,
120 PSCI_FN_SYSTEM_OFF,
121 PSCI_FN_SYSTEM_RESET,
122 PSCI_FN_MAX
123 };
124 #endif
125
126 #endif /* _MACHINE_PSCI_H_ */
127