xref: /freebsd/sys/dev/psci/psci.h (revision c2dd354bf4d3f8256d9e35d184369f939db96b96)
146b1fe92SAndrew Turner /*-
246b1fe92SAndrew Turner  * Copyright (c) 2013, 2014 Robin Randhawa
346b1fe92SAndrew Turner  * All rights reserved.
446b1fe92SAndrew Turner  *
546b1fe92SAndrew Turner  * Redistribution and use in source and binary forms, with or without
646b1fe92SAndrew Turner  * modification, are permitted provided that the following conditions
746b1fe92SAndrew Turner  * are met:
846b1fe92SAndrew Turner  * 1. Redistributions of source code must retain the above copyright
946b1fe92SAndrew Turner  *    notice, this list of conditions and the following disclaimer.
1046b1fe92SAndrew Turner  * 2. Redistributions in binary form must reproduce the above copyright
1146b1fe92SAndrew Turner  *    notice, this list of conditions and the following disclaimer in the
1246b1fe92SAndrew Turner  *    documentation and/or other materials provided with the distribution.
1346b1fe92SAndrew Turner  *
1446b1fe92SAndrew Turner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1546b1fe92SAndrew Turner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1646b1fe92SAndrew Turner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1746b1fe92SAndrew Turner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1846b1fe92SAndrew Turner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1946b1fe92SAndrew Turner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2046b1fe92SAndrew Turner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2146b1fe92SAndrew Turner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2246b1fe92SAndrew Turner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2346b1fe92SAndrew Turner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2446b1fe92SAndrew Turner  * SUCH DAMAGE.
2546b1fe92SAndrew Turner  *
2646b1fe92SAndrew Turner  * $FreeBSD$
2746b1fe92SAndrew Turner  */
2846b1fe92SAndrew Turner 
2946b1fe92SAndrew Turner #ifndef	_MACHINE_PSCI_H_
3046b1fe92SAndrew Turner #define	_MACHINE_PSCI_H_
3146b1fe92SAndrew Turner 
3246b1fe92SAndrew Turner #include <sys/types.h>
3346b1fe92SAndrew Turner 
3446b1fe92SAndrew Turner typedef int (*psci_initfn_t)(device_t dev);
3546b1fe92SAndrew Turner typedef int (*psci_callfn_t)(register_t, register_t, register_t, register_t);
3646b1fe92SAndrew Turner 
3746b1fe92SAndrew Turner extern int psci_present;
3846b1fe92SAndrew Turner 
3946b1fe92SAndrew Turner void	psci_system_reset(void);
4046b1fe92SAndrew Turner int	psci_cpu_on(unsigned long, unsigned long, unsigned long);
4146b1fe92SAndrew Turner int	psci_hvc_despatch(register_t, register_t, register_t, register_t);
4246b1fe92SAndrew Turner int	psci_smc_despatch(register_t, register_t, register_t, register_t);
4346b1fe92SAndrew Turner 
4446b1fe92SAndrew Turner 
4546b1fe92SAndrew Turner /*
4646b1fe92SAndrew Turner  * PSCI return codes.
4746b1fe92SAndrew Turner  */
4846b1fe92SAndrew Turner #define	PSCI_RETVAL_SUCCESS		0
4946b1fe92SAndrew Turner #define	PSCI_RETVAL_NOT_SUPPORTED	-1
5046b1fe92SAndrew Turner #define	PSCI_RETVAL_INVALID_PARAMS	-2
5146b1fe92SAndrew Turner #define	PSCI_RETVAL_DENIED		-3
5246b1fe92SAndrew Turner #define	PSCI_RETVAL_ALREADY_ON		-4
5346b1fe92SAndrew Turner #define	PSCI_RETVAL_ON_PENDING		-5
5446b1fe92SAndrew Turner #define	PSCI_RETVAL_INTERNAL_FAILURE	-6
5546b1fe92SAndrew Turner #define	PSCI_RETVAL_NOT_PRESENT		-7
5646b1fe92SAndrew Turner #define	PSCI_RETVAL_DISABLED		-8
57*c2dd354bSAndrew Turner /*
58*c2dd354bSAndrew Turner  * Used to signal PSCI is not available, e.g. to start a CPU.
59*c2dd354bSAndrew Turner  */
60*c2dd354bSAndrew Turner #define	PSCI_MISSING			1
6146b1fe92SAndrew Turner 
6246b1fe92SAndrew Turner /*
6346b1fe92SAndrew Turner  * PSCI function codes (as per PSCI v0.2).
6446b1fe92SAndrew Turner  */
6546b1fe92SAndrew Turner #ifdef __aarch64__
6646b1fe92SAndrew Turner #define	PSCI_FNID_VERSION		0x84000000
6746b1fe92SAndrew Turner #define	PSCI_FNID_CPU_SUSPEND		0xc4000001
6846b1fe92SAndrew Turner #define	PSCI_FNID_CPU_OFF		0x84000002
6946b1fe92SAndrew Turner #define	PSCI_FNID_CPU_ON		0xc4000003
7046b1fe92SAndrew Turner #define	PSCI_FNID_AFFINITY_INFO		0xc4000004
7146b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE		0xc4000005
7246b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_TYPE	0x84000006
7346b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_UP_CPU	0xc4000007
7446b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_OFF		0x84000008
7546b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_RESET		0x84000009
7646b1fe92SAndrew Turner #else
7746b1fe92SAndrew Turner #define	PSCI_FNID_VERSION		0x84000000
7846b1fe92SAndrew Turner #define	PSCI_FNID_CPU_SUSPEND		0x84000001
7946b1fe92SAndrew Turner #define	PSCI_FNID_CPU_OFF		0x84000002
8046b1fe92SAndrew Turner #define	PSCI_FNID_CPU_ON		0x84000003
8146b1fe92SAndrew Turner #define	PSCI_FNID_AFFINITY_INFO		0x84000004
8246b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE		0x84000005
8346b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_TYPE	0x84000006
8446b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_UP_CPU	0x84000007
8546b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_OFF		0x84000008
8646b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_RESET		0x84000009
8746b1fe92SAndrew Turner #endif
8846b1fe92SAndrew Turner 
8946b1fe92SAndrew Turner #define	PSCI_VER_MAJOR(v)		(((v) >> 16) & 0xFF)
9046b1fe92SAndrew Turner #define	PSCI_VER_MINOR(v)		((v) & 0xFF)
9146b1fe92SAndrew Turner 
9246b1fe92SAndrew Turner enum psci_fn {
9346b1fe92SAndrew Turner 	PSCI_FN_VERSION,
9446b1fe92SAndrew Turner 	PSCI_FN_CPU_SUSPEND,
9546b1fe92SAndrew Turner 	PSCI_FN_CPU_OFF,
9646b1fe92SAndrew Turner 	PSCI_FN_CPU_ON,
9746b1fe92SAndrew Turner 	PSCI_FN_AFFINITY_INFO,
9846b1fe92SAndrew Turner 	PSCI_FN_MIGRATE,
9946b1fe92SAndrew Turner 	PSCI_FN_MIGRATE_INFO_TYPE,
10046b1fe92SAndrew Turner 	PSCI_FN_MIGRATE_INFO_UP_CPU,
10146b1fe92SAndrew Turner 	PSCI_FN_SYSTEM_OFF,
10246b1fe92SAndrew Turner 	PSCI_FN_SYSTEM_RESET,
10346b1fe92SAndrew Turner 	PSCI_FN_MAX
10446b1fe92SAndrew Turner };
10546b1fe92SAndrew Turner 
10646b1fe92SAndrew Turner #endif /* _MACHINE_PSCI_H_ */
107