xref: /freebsd/sys/dev/psci/psci.h (revision 2a58b312)
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  * $FreeBSD$
27  */
28 
29 #ifndef	_MACHINE_PSCI_H_
30 #define	_MACHINE_PSCI_H_
31 
32 #include <sys/types.h>
33 #include <dev/psci/smccc.h>
34 
35 #ifdef _KERNEL
36 typedef int (*psci_initfn_t)(device_t dev, int default_version);
37 typedef int (*psci_callfn_t)(register_t, register_t, register_t, register_t,
38 	register_t, register_t, register_t, register_t,
39 	struct arm_smccc_res *res);
40 
41 extern bool psci_present;
42 
43 int	psci_cpu_on(unsigned long, unsigned long, unsigned long);
44 void	psci_reset(void);
45 int32_t	psci_features(uint32_t);
46 int	psci_get_version(void);
47 
48 /* Handler to let us call into the PSCI/SMCCC firmware */
49 extern psci_callfn_t psci_callfn;
50 static inline int
51 psci_call(register_t a, register_t b, register_t c, register_t d)
52 {
53 
54 	return (psci_callfn(a, b, c, d, 0, 0, 0, 0, NULL));
55 }
56 #endif
57 
58 /*
59  * PSCI return codes.
60  */
61 #define	PSCI_RETVAL_SUCCESS		0
62 #define	PSCI_RETVAL_NOT_SUPPORTED	-1
63 #define	PSCI_RETVAL_INVALID_PARAMS	-2
64 #define	PSCI_RETVAL_DENIED		-3
65 #define	PSCI_RETVAL_ALREADY_ON		-4
66 #define	PSCI_RETVAL_ON_PENDING		-5
67 #define	PSCI_RETVAL_INTERNAL_FAILURE	-6
68 #define	PSCI_RETVAL_NOT_PRESENT		-7
69 #define	PSCI_RETVAL_DISABLED		-8
70 /*
71  * Used to signal PSCI is not available, e.g. to start a CPU.
72  */
73 #define	PSCI_MISSING			1
74 
75 /*
76  * PSCI function codes (as per PSCI v0.2).
77  */
78 #ifdef __aarch64__
79 #define	PSCI_FNID_VERSION		0x84000000
80 #define	PSCI_FNID_CPU_SUSPEND		0xc4000001
81 #define	PSCI_FNID_CPU_OFF		0x84000002
82 #define	PSCI_FNID_CPU_ON		0xc4000003
83 #define	PSCI_FNID_AFFINITY_INFO		0xc4000004
84 #define	PSCI_FNID_MIGRATE		0xc4000005
85 #define	PSCI_FNID_MIGRATE_INFO_TYPE	0x84000006
86 #define	PSCI_FNID_MIGRATE_INFO_UP_CPU	0xc4000007
87 #define	PSCI_FNID_SYSTEM_OFF		0x84000008
88 #define	PSCI_FNID_SYSTEM_RESET		0x84000009
89 #define	PSCI_FNID_FEATURES		0x8400000a
90 #else
91 #define	PSCI_FNID_VERSION		0x84000000
92 #define	PSCI_FNID_CPU_SUSPEND		0x84000001
93 #define	PSCI_FNID_CPU_OFF		0x84000002
94 #define	PSCI_FNID_CPU_ON		0x84000003
95 #define	PSCI_FNID_AFFINITY_INFO		0x84000004
96 #define	PSCI_FNID_MIGRATE		0x84000005
97 #define	PSCI_FNID_MIGRATE_INFO_TYPE	0x84000006
98 #define	PSCI_FNID_MIGRATE_INFO_UP_CPU	0x84000007
99 #define	PSCI_FNID_SYSTEM_OFF		0x84000008
100 #define	PSCI_FNID_SYSTEM_RESET		0x84000009
101 #define	PSCI_FNID_FEATURES		0x8400000a
102 #endif
103 
104 #define	PSCI_VER_MAJOR(v)		(((v) >> 16) & 0xFF)
105 #define	PSCI_VER_MINOR(v)		((v) & 0xFF)
106 #define	PSCI_VER(maj, min)		(((maj) << 16) | (min))
107 
108 #define	PSCI_AFFINITY_INFO_ON		0
109 #define	PSCI_AFFINITY_INFO_OFF		1
110 #define	PSCI_AFFINITY_INFO_ON_PENDING	2
111 
112 #ifdef _KERNEL
113 enum psci_fn {
114 	PSCI_FN_VERSION,
115 	PSCI_FN_CPU_SUSPEND,
116 	PSCI_FN_CPU_OFF,
117 	PSCI_FN_CPU_ON,
118 	PSCI_FN_AFFINITY_INFO,
119 	PSCI_FN_MIGRATE,
120 	PSCI_FN_MIGRATE_INFO_TYPE,
121 	PSCI_FN_MIGRATE_INFO_UP_CPU,
122 	PSCI_FN_SYSTEM_OFF,
123 	PSCI_FN_SYSTEM_RESET,
124 	PSCI_FN_MAX
125 };
126 #endif
127 
128 #endif /* _MACHINE_PSCI_H_ */
129