xref: /rk3399_ARM-atf/plat/xilinx/common/include/pm_common.h (revision 80684b7e9e9ed4574bc64948740b99cb31d1e10a)
1 /*
2  * Copyright (c) 2013-2018, Arm Limited and Contributors. All rights reserved.
3  * Copyright (c) 2022-2025, Advanced Micro Devices, Inc. All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  */
7 
8 /*
9  * Contains definitions of commonly used macros and data types needed
10  * for PU Power Management. This file should be common for all PU's.
11  */
12 
13 #ifndef PM_COMMON_H
14 #define PM_COMMON_H
15 
16 #include <stdint.h>
17 
18 #if IPI_CRC_CHECK
19 #define PAYLOAD_ARG_CNT         8U
20 #define IPI_W0_TO_W6_SIZE       28U
21 #define PAYLOAD_CRC_POS         7U
22 #define CRC_INIT_VALUE          0x4F4EU
23 #define CRC_ORDER               16U
24 #define CRC_POLYNOM             0x8005U
25 #else
26 #define PAYLOAD_ARG_CNT		7U
27 #endif
28 #define RET_PAYLOAD_ARG_CNT	6U
29 #define PAYLOAD_ARG_SIZE	4U	/* size in bytes */
30 
31 #define TZ_VERSION_MAJOR	1U
32 #define TZ_VERSION_MINOR	0U
33 #define TZ_VERSION		(((uint32_t)TZ_VERSION_MAJOR << 16U) | \
34 				 TZ_VERSION_MINOR)
35 
36 /**
37  * struct pm_ipi - struct for capturing IPI-channel specific info.
38  * @local_ipi_id: Local IPI agent ID.
39  * @remote_ipi_id: Remote IPI Agent ID.
40  * @buffer_base: base address for payload buffer.
41  *
42  */
43 struct pm_ipi {
44 	const uint32_t local_ipi_id;
45 	const uint32_t remote_ipi_id;
46 	const uintptr_t buffer_base;
47 };
48 
49 /**
50  * struct pm_proc - struct for capturing processor related info.
51  * @node_id: node-ID of the processor.
52  * @pwrdn_mask: cpu-specific mask to be used for power control register.
53  * @ipi: pointer to IPI channel structure.
54  *       (in APU all processors share one IPI channel)
55  *
56  */
57 struct pm_proc {
58 	const uint32_t node_id;
59 	const uint32_t pwrdn_mask;
60 	const struct pm_ipi *ipi;
61 };
62 
63 const struct pm_proc *pm_get_proc(uint32_t cpuid);
64 
65 #endif /* PM_COMMON_H */
66