xref: /rk3399_ARM-atf/include/lib/pmf/pmf.h (revision 62865b4ee455806e37a9c5bd52255b8c09cf1a1a)
1afdda571Sdp-arm /*
2f7679d43SGovindraj Raja  * Copyright (c) 2016-2024, Arm Limited and Contributors. All rights reserved.
3afdda571Sdp-arm  *
482cb2c1aSdp-arm  * SPDX-License-Identifier: BSD-3-Clause
5afdda571Sdp-arm  */
6afdda571Sdp-arm 
7bef9a10fSAntonio Nino Diaz #ifndef PMF_H
8bef9a10fSAntonio Nino Diaz #define PMF_H
9afdda571Sdp-arm 
1009d40e0eSAntonio Nino Diaz #include <lib/cassert.h>
1109d40e0eSAntonio Nino Diaz #include <lib/pmf/pmf_helpers.h>
1209d40e0eSAntonio Nino Diaz #include <lib/utils_def.h>
13afdda571Sdp-arm 
14afdda571Sdp-arm /*
15afdda571Sdp-arm  * Constants used for/by PMF services.
16afdda571Sdp-arm  */
17d7b5f408SJimmy Brisson #define PMF_ARM_TIF_IMPL_ID	UL(0x41)
18afdda571Sdp-arm #define PMF_TID_SHIFT		0
19d7b5f408SJimmy Brisson #define PMF_TID_MASK		(UL(0xFF) << PMF_TID_SHIFT)
20afdda571Sdp-arm #define PMF_SVC_ID_SHIFT	10
21d7b5f408SJimmy Brisson #define PMF_SVC_ID_MASK		(UL(0x3F) << PMF_SVC_ID_SHIFT)
22afdda571Sdp-arm #define PMF_IMPL_ID_SHIFT	24
23d7b5f408SJimmy Brisson #define PMF_IMPL_ID_MASK	(UL(0xFF) << PMF_IMPL_ID_SHIFT)
24afdda571Sdp-arm 
25afdda571Sdp-arm /*
26afdda571Sdp-arm  * Flags passed to PMF_REGISTER_SERVICE
27afdda571Sdp-arm  */
28afdda571Sdp-arm #define PMF_STORE_ENABLE	(1 << 0)
29afdda571Sdp-arm #define PMF_DUMP_ENABLE		(1 << 1)
30afdda571Sdp-arm 
31afdda571Sdp-arm /*
32afdda571Sdp-arm  * Flags passed to PMF_GET_TIMESTAMP_XXX
33afdda571Sdp-arm  * and PMF_CAPTURE_TIMESTAMP
34afdda571Sdp-arm  */
35bef9a10fSAntonio Nino Diaz #define PMF_CACHE_MAINT		(U(1) << 0)
36bef9a10fSAntonio Nino Diaz #define PMF_NO_CACHE_MAINT	U(0)
37afdda571Sdp-arm 
38afdda571Sdp-arm /*
39f7679d43SGovindraj Raja  * Defines for PMF SMC function ids used with arm-sip
40f7679d43SGovindraj Raja  * range, this is now deprecated and will be removed.
41afdda571Sdp-arm  */
42f7679d43SGovindraj Raja #define PMF_SMC_GET_TIMESTAMP_32_DEP	U(0x82000010)
43f7679d43SGovindraj Raja #define PMF_SMC_GET_TIMESTAMP_64_DEP	U(0xC2000010)
44f7679d43SGovindraj Raja 
45f7679d43SGovindraj Raja #define PMF_FID_VALUE_DEPRECATED	U(0x10)
46f7679d43SGovindraj Raja #define is_pmf_fid_deprecated(_fid) \
47*62865b4eSGovindraj Raja 	(GET_SMC_NUM(_fid) == PMF_FID_VALUE_DEPRECATED)
48f7679d43SGovindraj Raja 
49f7679d43SGovindraj Raja /*
50f7679d43SGovindraj Raja  * Defines for PMF SMC function ids used with Vendor-Specific
51f7679d43SGovindraj Raja  * EL3 range.
52f7679d43SGovindraj Raja  */
53f7679d43SGovindraj Raja #define PMF_SMC_GET_TIMESTAMP_32	U(0x87000020)
54f7679d43SGovindraj Raja #define PMF_SMC_GET_TIMESTAMP_64	U(0xC7000020)
55afdda571Sdp-arm #define PMF_NUM_SMC_CALLS		2
56afdda571Sdp-arm 
5742cbefc7SGovindraj Raja #define PMF_SMC_GET_VERSION_32		U(0x87000021)
5842cbefc7SGovindraj Raja #define PMF_SMC_GET_VERSION_64		U(0xC7000021)
5942cbefc7SGovindraj Raja 
6042cbefc7SGovindraj Raja #define PMF_SMC_VERSION			U(0x00000001)
6142cbefc7SGovindraj Raja 
62afdda571Sdp-arm /*
63afdda571Sdp-arm  * The macros below are used to identify
64afdda571Sdp-arm  * PMF calls from the SMC function ID.
65afdda571Sdp-arm  */
66f7679d43SGovindraj Raja #define PMF_FID_VALUE		U(0x20)
67*62865b4eSGovindraj Raja #define PMF_ID_MASK		(FUNCID_NUM_MASK & ~(0xf))
68*62865b4eSGovindraj Raja #define is_pmf_fid(_fid)	((GET_SMC_NUM(_fid) & PMF_ID_MASK) == PMF_FID_VALUE)
69afdda571Sdp-arm 
70afdda571Sdp-arm /* Following are the supported PMF service IDs */
71afdda571Sdp-arm #define PMF_PSCI_STAT_SVC_ID	0
72872be88aSdp-arm #define PMF_RT_INSTR_SVC_ID	1
73afdda571Sdp-arm 
74afdda571Sdp-arm /*******************************************************************************
75afdda571Sdp-arm  * Function & variable prototypes
76afdda571Sdp-arm  ******************************************************************************/
77afdda571Sdp-arm /* PMF common functions */
78afdda571Sdp-arm int pmf_get_timestamp_smc(unsigned int tid,
79afdda571Sdp-arm 		u_register_t mpidr,
80afdda571Sdp-arm 		unsigned int flags,
819fb8af33SRoberto Vargas 		unsigned long long *ts_value);
82afdda571Sdp-arm int pmf_setup(void);
83afdda571Sdp-arm uintptr_t pmf_smc_handler(unsigned int smc_fid,
84afdda571Sdp-arm 		u_register_t x1,
85afdda571Sdp-arm 		u_register_t x2,
86afdda571Sdp-arm 		u_register_t x3,
87afdda571Sdp-arm 		u_register_t x4,
88afdda571Sdp-arm 		void *cookie,
89afdda571Sdp-arm 		void *handle,
90afdda571Sdp-arm 		u_register_t flags);
91afdda571Sdp-arm 
92bef9a10fSAntonio Nino Diaz #endif /* PMF_H */
93