Home | History | Annotate | Download | only in linux
      1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
      2 /*
      3  * ARM Power State and Coordination Interface (PSCI) header
      4  *
      5  * This header holds common PSCI defines and macros shared
      6  * by: ARM kernel, ARM64 kernel, KVM ARM/ARM64 and user space.
      7  *
      8  * Copyright (C) 2014 Linaro Ltd.
      9  * Author: Anup Patel <anup.patel (at) linaro.org>
     10  */
     11 
     12 #ifndef _UAPI_LINUX_PSCI_H
     13 #define _UAPI_LINUX_PSCI_H
     14 
     15 /*
     16  * PSCI v0.1 interface
     17  *
     18  * The PSCI v0.1 function numbers are implementation defined.
     19  *
     20  * Only PSCI return values such as: SUCCESS, NOT_SUPPORTED,
     21  * INVALID_PARAMS, and DENIED defined below are applicable
     22  * to PSCI v0.1.
     23  */
     24 
     25 /* PSCI v0.2 interface */
     26 #define PSCI_0_2_FN_BASE			0x84000000
     27 #define PSCI_0_2_FN(n)				(PSCI_0_2_FN_BASE + (n))
     28 #define PSCI_0_2_64BIT				0x40000000
     29 #define PSCI_0_2_FN64_BASE			\
     30 					(PSCI_0_2_FN_BASE + PSCI_0_2_64BIT)
     31 #define PSCI_0_2_FN64(n)			(PSCI_0_2_FN64_BASE + (n))
     32 
     33 #define PSCI_0_2_FN_PSCI_VERSION		PSCI_0_2_FN(0)
     34 #define PSCI_0_2_FN_CPU_SUSPEND			PSCI_0_2_FN(1)
     35 #define PSCI_0_2_FN_CPU_OFF			PSCI_0_2_FN(2)
     36 #define PSCI_0_2_FN_CPU_ON			PSCI_0_2_FN(3)
     37 #define PSCI_0_2_FN_AFFINITY_INFO		PSCI_0_2_FN(4)
     38 #define PSCI_0_2_FN_MIGRATE			PSCI_0_2_FN(5)
     39 #define PSCI_0_2_FN_MIGRATE_INFO_TYPE		PSCI_0_2_FN(6)
     40 #define PSCI_0_2_FN_MIGRATE_INFO_UP_CPU		PSCI_0_2_FN(7)
     41 #define PSCI_0_2_FN_SYSTEM_OFF			PSCI_0_2_FN(8)
     42 #define PSCI_0_2_FN_SYSTEM_RESET		PSCI_0_2_FN(9)
     43 
     44 #define PSCI_0_2_FN64_CPU_SUSPEND		PSCI_0_2_FN64(1)
     45 #define PSCI_0_2_FN64_CPU_ON			PSCI_0_2_FN64(3)
     46 #define PSCI_0_2_FN64_AFFINITY_INFO		PSCI_0_2_FN64(4)
     47 #define PSCI_0_2_FN64_MIGRATE			PSCI_0_2_FN64(5)
     48 #define PSCI_0_2_FN64_MIGRATE_INFO_UP_CPU	PSCI_0_2_FN64(7)
     49 
     50 #define PSCI_1_0_FN_PSCI_FEATURES		PSCI_0_2_FN(10)
     51 #define PSCI_1_0_FN_SYSTEM_SUSPEND		PSCI_0_2_FN(14)
     52 
     53 #define PSCI_1_0_FN64_SYSTEM_SUSPEND		PSCI_0_2_FN64(14)
     54 
     55 /* PSCI v0.2 power state encoding for CPU_SUSPEND function */
     56 #define PSCI_0_2_POWER_STATE_ID_MASK		0xffff
     57 #define PSCI_0_2_POWER_STATE_ID_SHIFT		0
     58 #define PSCI_0_2_POWER_STATE_TYPE_SHIFT		16
     59 #define PSCI_0_2_POWER_STATE_TYPE_MASK		\
     60 				(0x1 << PSCI_0_2_POWER_STATE_TYPE_SHIFT)
     61 #define PSCI_0_2_POWER_STATE_AFFL_SHIFT		24
     62 #define PSCI_0_2_POWER_STATE_AFFL_MASK		\
     63 				(0x3 << PSCI_0_2_POWER_STATE_AFFL_SHIFT)
     64 
     65 /* PSCI extended power state encoding for CPU_SUSPEND function */
     66 #define PSCI_1_0_EXT_POWER_STATE_ID_MASK	0xfffffff
     67 #define PSCI_1_0_EXT_POWER_STATE_ID_SHIFT	0
     68 #define PSCI_1_0_EXT_POWER_STATE_TYPE_SHIFT	30
     69 #define PSCI_1_0_EXT_POWER_STATE_TYPE_MASK	\
     70 				(0x1 << PSCI_1_0_EXT_POWER_STATE_TYPE_SHIFT)
     71 
     72 /* PSCI v0.2 affinity level state returned by AFFINITY_INFO */
     73 #define PSCI_0_2_AFFINITY_LEVEL_ON		0
     74 #define PSCI_0_2_AFFINITY_LEVEL_OFF		1
     75 #define PSCI_0_2_AFFINITY_LEVEL_ON_PENDING	2
     76 
     77 /* PSCI v0.2 multicore support in Trusted OS returned by MIGRATE_INFO_TYPE */
     78 #define PSCI_0_2_TOS_UP_MIGRATE			0
     79 #define PSCI_0_2_TOS_UP_NO_MIGRATE		1
     80 #define PSCI_0_2_TOS_MP				2
     81 
     82 /* PSCI version decoding (independent of PSCI version) */
     83 #define PSCI_VERSION_MAJOR_SHIFT		16
     84 #define PSCI_VERSION_MINOR_MASK			\
     85 		((1U << PSCI_VERSION_MAJOR_SHIFT) - 1)
     86 #define PSCI_VERSION_MAJOR_MASK			~PSCI_VERSION_MINOR_MASK
     87 #define PSCI_VERSION_MAJOR(ver)			\
     88 		(((ver) & PSCI_VERSION_MAJOR_MASK) >> PSCI_VERSION_MAJOR_SHIFT)
     89 #define PSCI_VERSION_MINOR(ver)			\
     90 		((ver) & PSCI_VERSION_MINOR_MASK)
     91 
     92 /* PSCI features decoding (>=1.0) */
     93 #define PSCI_1_0_FEATURES_CPU_SUSPEND_PF_SHIFT	1
     94 #define PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK	\
     95 			(0x1 << PSCI_1_0_FEATURES_CPU_SUSPEND_PF_SHIFT)
     96 
     97 /* PSCI return values (inclusive of all PSCI versions) */
     98 #define PSCI_RET_SUCCESS			0
     99 #define PSCI_RET_NOT_SUPPORTED			-1
    100 #define PSCI_RET_INVALID_PARAMS			-2
    101 #define PSCI_RET_DENIED				-3
    102 #define PSCI_RET_ALREADY_ON			-4
    103 #define PSCI_RET_ON_PENDING			-5
    104 #define PSCI_RET_INTERNAL_FAILURE		-6
    105 #define PSCI_RET_NOT_PRESENT			-7
    106 #define PSCI_RET_DISABLED			-8
    107 #define PSCI_RET_INVALID_ADDRESS		-9
    108 
    109 #endif /* _UAPI_LINUX_PSCI_H */
    110