xref: /netbsd-src/sys/arch/arm/arm/smccc.h (revision 5e5c370de3250cba5abaece46ae510036b19aff2)
1 /* $NetBSD: smccc.h,v 1.2 2021/08/07 21:21:49 jmcneill Exp $ */
2 
3 /*-
4  * Copyright (c) 2021 Jared McNeill <jmcneill@invisible.ca>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _ARM_SMCCC_H
30 #define _ARM_SMCCC_H
31 
32 /*
33  * SMCCC return codes
34  */
35 #define	SMCCC_SUCCESS			0
36 #define	SMCCC_NOT_SUPPORTED		-1
37 #define	SMCCC_NOT_REQUIRED		-2
38 #define	SMCCC_INVALID_PARAMETER		-3
39 
40 /*
41  * Returns true if SMCCC is supported.
42  */
43 bool	smccc_probe(void);
44 
45 /*
46  * Get SMCCC version.
47  */
48 int	smccc_version(void);
49 
50 /*
51  * Call an SMC/HVC service.
52  */
53 int	smccc_call(uint32_t, register_t, register_t, register_t, register_t,
54 		   register_t *, register_t *, register_t *, register_t *);
55 
56 #endif /* _ARM_SMCCC_H */
57