xref: /arm-trusted-firmware/include/lib/pmf/pmf.h (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700Schasinglulu /*
2*91f16700Schasinglulu  * Copyright (c) 2016-2020, Arm Limited and Contributors. All rights reserved.
3*91f16700Schasinglulu  *
4*91f16700Schasinglulu  * SPDX-License-Identifier: BSD-3-Clause
5*91f16700Schasinglulu  */
6*91f16700Schasinglulu 
7*91f16700Schasinglulu #ifndef PMF_H
8*91f16700Schasinglulu #define PMF_H
9*91f16700Schasinglulu 
10*91f16700Schasinglulu #include <lib/cassert.h>
11*91f16700Schasinglulu #include <lib/pmf/pmf_helpers.h>
12*91f16700Schasinglulu #include <lib/utils_def.h>
13*91f16700Schasinglulu 
14*91f16700Schasinglulu /*
15*91f16700Schasinglulu  * Constants used for/by PMF services.
16*91f16700Schasinglulu  */
17*91f16700Schasinglulu #define PMF_ARM_TIF_IMPL_ID	UL(0x41)
18*91f16700Schasinglulu #define PMF_TID_SHIFT		0
19*91f16700Schasinglulu #define PMF_TID_MASK		(UL(0xFF) << PMF_TID_SHIFT)
20*91f16700Schasinglulu #define PMF_SVC_ID_SHIFT	10
21*91f16700Schasinglulu #define PMF_SVC_ID_MASK		(UL(0x3F) << PMF_SVC_ID_SHIFT)
22*91f16700Schasinglulu #define PMF_IMPL_ID_SHIFT	24
23*91f16700Schasinglulu #define PMF_IMPL_ID_MASK	(UL(0xFF) << PMF_IMPL_ID_SHIFT)
24*91f16700Schasinglulu 
25*91f16700Schasinglulu /*
26*91f16700Schasinglulu  * Flags passed to PMF_REGISTER_SERVICE
27*91f16700Schasinglulu  */
28*91f16700Schasinglulu #define PMF_STORE_ENABLE	(1 << 0)
29*91f16700Schasinglulu #define PMF_DUMP_ENABLE		(1 << 1)
30*91f16700Schasinglulu 
31*91f16700Schasinglulu /*
32*91f16700Schasinglulu  * Flags passed to PMF_GET_TIMESTAMP_XXX
33*91f16700Schasinglulu  * and PMF_CAPTURE_TIMESTAMP
34*91f16700Schasinglulu  */
35*91f16700Schasinglulu #define PMF_CACHE_MAINT		(U(1) << 0)
36*91f16700Schasinglulu #define PMF_NO_CACHE_MAINT	U(0)
37*91f16700Schasinglulu 
38*91f16700Schasinglulu /*
39*91f16700Schasinglulu  * Defines for PMF SMC function ids.
40*91f16700Schasinglulu  */
41*91f16700Schasinglulu #define PMF_SMC_GET_TIMESTAMP_32	U(0x82000010)
42*91f16700Schasinglulu #define PMF_SMC_GET_TIMESTAMP_64	U(0xC2000010)
43*91f16700Schasinglulu #define PMF_NUM_SMC_CALLS		2
44*91f16700Schasinglulu 
45*91f16700Schasinglulu /*
46*91f16700Schasinglulu  * The macros below are used to identify
47*91f16700Schasinglulu  * PMF calls from the SMC function ID.
48*91f16700Schasinglulu  */
49*91f16700Schasinglulu #define PMF_FID_MASK	U(0xffe0)
50*91f16700Schasinglulu #define PMF_FID_VALUE	U(0)
51*91f16700Schasinglulu #define is_pmf_fid(_fid)	(((_fid) & PMF_FID_MASK) == PMF_FID_VALUE)
52*91f16700Schasinglulu 
53*91f16700Schasinglulu /* Following are the supported PMF service IDs */
54*91f16700Schasinglulu #define PMF_PSCI_STAT_SVC_ID	0
55*91f16700Schasinglulu #define PMF_RT_INSTR_SVC_ID	1
56*91f16700Schasinglulu 
57*91f16700Schasinglulu /*******************************************************************************
58*91f16700Schasinglulu  * Function & variable prototypes
59*91f16700Schasinglulu  ******************************************************************************/
60*91f16700Schasinglulu /* PMF common functions */
61*91f16700Schasinglulu int pmf_get_timestamp_smc(unsigned int tid,
62*91f16700Schasinglulu 		u_register_t mpidr,
63*91f16700Schasinglulu 		unsigned int flags,
64*91f16700Schasinglulu 		unsigned long long *ts_value);
65*91f16700Schasinglulu int pmf_setup(void);
66*91f16700Schasinglulu uintptr_t pmf_smc_handler(unsigned int smc_fid,
67*91f16700Schasinglulu 		u_register_t x1,
68*91f16700Schasinglulu 		u_register_t x2,
69*91f16700Schasinglulu 		u_register_t x3,
70*91f16700Schasinglulu 		u_register_t x4,
71*91f16700Schasinglulu 		void *cookie,
72*91f16700Schasinglulu 		void *handle,
73*91f16700Schasinglulu 		u_register_t flags);
74*91f16700Schasinglulu 
75*91f16700Schasinglulu #endif /* PMF_H */
76