xref: /freebsd/sys/dev/psci/psci.h (revision e89be21854b3aa33efd2e06529a181343281659d)
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>
337722d8c7SRuslan Bukin #include <dev/psci/smccc.h>
3446b1fe92SAndrew Turner 
35473ab212SAndrew Turner #ifdef _KERNEL
3691e44013SMichal Meloun typedef int (*psci_initfn_t)(device_t dev, int default_version);
377722d8c7SRuslan Bukin typedef int (*psci_callfn_t)(register_t, register_t, register_t, register_t,
387722d8c7SRuslan Bukin 	register_t, register_t, register_t, register_t,
397722d8c7SRuslan Bukin 	struct arm_smccc_res *res);
4046b1fe92SAndrew Turner 
412218070bSKyle Evans extern bool psci_present;
4246b1fe92SAndrew Turner 
4346b1fe92SAndrew Turner int	psci_cpu_on(unsigned long, unsigned long, unsigned long);
445add8393SAndrew Turner void	psci_reset(void);
455add8393SAndrew Turner int32_t	psci_features(uint32_t);
465add8393SAndrew Turner int	psci_get_version(void);
475add8393SAndrew Turner 
489e8cb3d2SAndrew Turner /* Handler to let us call into the PSCI/SMCCC firmware */
499e8cb3d2SAndrew Turner extern psci_callfn_t psci_callfn;
509e8cb3d2SAndrew Turner static inline int
519e8cb3d2SAndrew Turner psci_call(register_t a, register_t b, register_t c, register_t d)
529e8cb3d2SAndrew Turner {
539e8cb3d2SAndrew Turner 
547722d8c7SRuslan Bukin 	return (psci_callfn(a, b, c, d, 0, 0, 0, 0, NULL));
559e8cb3d2SAndrew Turner }
56473ab212SAndrew Turner #endif
5746b1fe92SAndrew Turner 
5846b1fe92SAndrew Turner /*
5946b1fe92SAndrew Turner  * PSCI return codes.
6046b1fe92SAndrew Turner  */
6146b1fe92SAndrew Turner #define	PSCI_RETVAL_SUCCESS		0
6246b1fe92SAndrew Turner #define	PSCI_RETVAL_NOT_SUPPORTED	-1
6346b1fe92SAndrew Turner #define	PSCI_RETVAL_INVALID_PARAMS	-2
6446b1fe92SAndrew Turner #define	PSCI_RETVAL_DENIED		-3
6546b1fe92SAndrew Turner #define	PSCI_RETVAL_ALREADY_ON		-4
6646b1fe92SAndrew Turner #define	PSCI_RETVAL_ON_PENDING		-5
6746b1fe92SAndrew Turner #define	PSCI_RETVAL_INTERNAL_FAILURE	-6
6846b1fe92SAndrew Turner #define	PSCI_RETVAL_NOT_PRESENT		-7
6946b1fe92SAndrew Turner #define	PSCI_RETVAL_DISABLED		-8
70c2dd354bSAndrew Turner /*
71c2dd354bSAndrew Turner  * Used to signal PSCI is not available, e.g. to start a CPU.
72c2dd354bSAndrew Turner  */
73c2dd354bSAndrew Turner #define	PSCI_MISSING			1
7446b1fe92SAndrew Turner 
7546b1fe92SAndrew Turner /*
7646b1fe92SAndrew Turner  * PSCI function codes (as per PSCI v0.2).
7746b1fe92SAndrew Turner  */
7846b1fe92SAndrew Turner #ifdef __aarch64__
7946b1fe92SAndrew Turner #define	PSCI_FNID_VERSION		0x84000000
8046b1fe92SAndrew Turner #define	PSCI_FNID_CPU_SUSPEND		0xc4000001
8146b1fe92SAndrew Turner #define	PSCI_FNID_CPU_OFF		0x84000002
8246b1fe92SAndrew Turner #define	PSCI_FNID_CPU_ON		0xc4000003
8346b1fe92SAndrew Turner #define	PSCI_FNID_AFFINITY_INFO		0xc4000004
8446b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE		0xc4000005
8546b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_TYPE	0x84000006
8646b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_UP_CPU	0xc4000007
8746b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_OFF		0x84000008
8846b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_RESET		0x84000009
89811880f2SAndrew Turner #define	PSCI_FNID_FEATURES		0x8400000a
9046b1fe92SAndrew Turner #else
9146b1fe92SAndrew Turner #define	PSCI_FNID_VERSION		0x84000000
9246b1fe92SAndrew Turner #define	PSCI_FNID_CPU_SUSPEND		0x84000001
9346b1fe92SAndrew Turner #define	PSCI_FNID_CPU_OFF		0x84000002
9446b1fe92SAndrew Turner #define	PSCI_FNID_CPU_ON		0x84000003
9546b1fe92SAndrew Turner #define	PSCI_FNID_AFFINITY_INFO		0x84000004
9646b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE		0x84000005
9746b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_TYPE	0x84000006
9846b1fe92SAndrew Turner #define	PSCI_FNID_MIGRATE_INFO_UP_CPU	0x84000007
9946b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_OFF		0x84000008
10046b1fe92SAndrew Turner #define	PSCI_FNID_SYSTEM_RESET		0x84000009
101811880f2SAndrew Turner #define	PSCI_FNID_FEATURES		0x8400000a
10246b1fe92SAndrew Turner #endif
10346b1fe92SAndrew Turner 
10446b1fe92SAndrew Turner #define	PSCI_VER_MAJOR(v)		(((v) >> 16) & 0xFF)
10546b1fe92SAndrew Turner #define	PSCI_VER_MINOR(v)		((v) & 0xFF)
106*e89be218SAndrew Turner #define	PSCI_VER(maj, min)		(((maj) << 16) | (min))
10746b1fe92SAndrew Turner 
108473ab212SAndrew Turner #ifdef _KERNEL
10946b1fe92SAndrew Turner enum psci_fn {
11046b1fe92SAndrew Turner 	PSCI_FN_VERSION,
11146b1fe92SAndrew Turner 	PSCI_FN_CPU_SUSPEND,
11246b1fe92SAndrew Turner 	PSCI_FN_CPU_OFF,
11346b1fe92SAndrew Turner 	PSCI_FN_CPU_ON,
11446b1fe92SAndrew Turner 	PSCI_FN_AFFINITY_INFO,
11546b1fe92SAndrew Turner 	PSCI_FN_MIGRATE,
11646b1fe92SAndrew Turner 	PSCI_FN_MIGRATE_INFO_TYPE,
11746b1fe92SAndrew Turner 	PSCI_FN_MIGRATE_INFO_UP_CPU,
11846b1fe92SAndrew Turner 	PSCI_FN_SYSTEM_OFF,
11946b1fe92SAndrew Turner 	PSCI_FN_SYSTEM_RESET,
12046b1fe92SAndrew Turner 	PSCI_FN_MAX
12146b1fe92SAndrew Turner };
122473ab212SAndrew Turner #endif
12346b1fe92SAndrew Turner 
12446b1fe92SAndrew Turner #endif /* _MACHINE_PSCI_H_ */
125