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