xref: /freebsd/sys/dev/psci/smccc.h (revision 0594061ee6fbd63d428e70cab4c82171f87f7604)
1f651b525SAndrew Turner /*-
2f651b525SAndrew Turner  * SPDX-License-Identifier: BSD-2-Clause
3f651b525SAndrew Turner  *
4f651b525SAndrew Turner  * Copyright (c) 2018 Andrew Turner
5f651b525SAndrew Turner  *
6f651b525SAndrew Turner  * This software was developed by SRI International and the University of
7f651b525SAndrew Turner  * Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
8f651b525SAndrew Turner  * ("CTSRD"), as part of the DARPA CRASH research programme.
9f651b525SAndrew Turner  *
10f651b525SAndrew Turner  * Redistribution and use in source and binary forms, with or without
11f651b525SAndrew Turner  * modification, are permitted provided that the following conditions
12f651b525SAndrew Turner  * are met:
13f651b525SAndrew Turner  * 1. Redistributions of source code must retain the above copyright
14f651b525SAndrew Turner  *    notice, this list of conditions and the following disclaimer.
15f651b525SAndrew Turner  * 2. Redistributions in binary form must reproduce the above copyright
16f651b525SAndrew Turner  *    notice, this list of conditions and the following disclaimer in the
17f651b525SAndrew Turner  *    documentation and/or other materials provided with the distribution.
18f651b525SAndrew Turner  *
19f651b525SAndrew Turner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20f651b525SAndrew Turner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21f651b525SAndrew Turner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22f651b525SAndrew Turner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23f651b525SAndrew Turner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24f651b525SAndrew Turner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25f651b525SAndrew Turner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f651b525SAndrew Turner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27f651b525SAndrew Turner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28f651b525SAndrew Turner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29f651b525SAndrew Turner  * SUCH DAMAGE.
30f651b525SAndrew Turner  *
31f651b525SAndrew Turner  * $FreeBSD$
32f651b525SAndrew Turner  */
33f651b525SAndrew Turner 
34f651b525SAndrew Turner #ifndef	_PSCI_SMCCC_H_
35f651b525SAndrew Turner #define	_PSCI_SMCCC_H_
36f651b525SAndrew Turner 
37f651b525SAndrew Turner #define	SMCCC_VERSION_MAJOR(ver)	(((ver) >> 16) & 0x7fff)
38f651b525SAndrew Turner #define	SMCCC_VERSION_MINOR(ver)	((ver) & 0xffff)
39f651b525SAndrew Turner 
40f651b525SAndrew Turner #define	SMCCC_FUNC_ID(type, call_conv, range, func)	\
41f651b525SAndrew Turner 	(((type) << 31) |				\
42f651b525SAndrew Turner 	 ((call_conv) << 30) |				\
43f651b525SAndrew Turner 	 (((range) & 0x3f) << 24) |				\
44f651b525SAndrew Turner 	 ((func) & 0xffff))
45f651b525SAndrew Turner 
46f651b525SAndrew Turner #define	SMCCC_YIELDING_CALL	0
47f651b525SAndrew Turner #define	SMCCC_FAST_CALL		1
48f651b525SAndrew Turner 
49f651b525SAndrew Turner #define	SMCCC_32BIT_CALL	0
50f651b525SAndrew Turner #define	SMCCC_64BIT_CALL	1
51f651b525SAndrew Turner 
5209d1a08dSAndrew Turner /*
5309d1a08dSAndrew Turner  * Arm Architecture Calls.
5409d1a08dSAndrew Turner  * These are documented in the document ARM DEN 0070A.
5509d1a08dSAndrew Turner  */
56f651b525SAndrew Turner #define	SMCCC_VERSION							\
5795c4b3c7SAndrew Turner     SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 0)
58f651b525SAndrew Turner #define	SMCCC_ARCH_FEATURES						\
5995c4b3c7SAndrew Turner     SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 1)
60f651b525SAndrew Turner #define	SMCCC_ARCH_WORKAROUND_1						\
6195c4b3c7SAndrew Turner     SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 0x8000)
62*0594061eSAndrew Turner #define	SMCCC_ARCH_WORKAROUND_2						\
63*0594061eSAndrew Turner     SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 0x7fff)
64f651b525SAndrew Turner 
6509d1a08dSAndrew Turner /* The return values from ARM DEN 0070A. */
6609d1a08dSAndrew Turner #define	SMCCC_RET_SUCCESS		0
6709d1a08dSAndrew Turner #define	SMCCC_RET_NOT_SUPPORTED		-1
6809d1a08dSAndrew Turner #define	SMCCC_RET_NOT_REQUIRED		-2
6909d1a08dSAndrew Turner 
70f651b525SAndrew Turner int32_t smccc_arch_features(uint32_t);
71f651b525SAndrew Turner int smccc_arch_workaround_1(void);
72*0594061eSAndrew Turner int smccc_arch_workaround_2(bool);
73f651b525SAndrew Turner 
74f651b525SAndrew Turner 
75f651b525SAndrew Turner #endif /* _PSCI_SMCCC_H_ */
76