xref: /arm-trusted-firmware/plat/xilinx/common/include/pm_client.h (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700Schasinglulu /*
2*91f16700Schasinglulu  * Copyright (c) 2013-2019, Arm Limited and Contributors. All rights reserved.
3*91f16700Schasinglulu  * Copyright (c) 2020-2022, Xilinx, Inc. All rights reserved.
4*91f16700Schasinglulu  * Copyright (c) 2022-2023, Advanced Micro Devices, Inc. All rights reserved.
5*91f16700Schasinglulu  *
6*91f16700Schasinglulu  * SPDX-License-Identifier: BSD-3-Clause
7*91f16700Schasinglulu  */
8*91f16700Schasinglulu 
9*91f16700Schasinglulu /*
10*91f16700Schasinglulu  * Contains APU specific macros and macros to be defined depending on
11*91f16700Schasinglulu  * the execution environment.
12*91f16700Schasinglulu  */
13*91f16700Schasinglulu 
14*91f16700Schasinglulu #ifndef PM_CLIENT_H
15*91f16700Schasinglulu #define PM_CLIENT_H
16*91f16700Schasinglulu 
17*91f16700Schasinglulu #include "pm_common.h"
18*91f16700Schasinglulu #include "pm_defs.h"
19*91f16700Schasinglulu 
20*91f16700Schasinglulu /* Functions to be implemented by each PU */
21*91f16700Schasinglulu void pm_client_suspend(const struct pm_proc *proc, uint32_t state);
22*91f16700Schasinglulu void pm_client_abort_suspend(void);
23*91f16700Schasinglulu void pm_client_wakeup(const struct pm_proc *proc);
24*91f16700Schasinglulu 
25*91f16700Schasinglulu #if !defined(PLAT_zynqmp)
26*91f16700Schasinglulu enum pm_device_node_idx irq_to_pm_node_idx(uint32_t irq);
27*91f16700Schasinglulu #endif
28*91f16700Schasinglulu 
29*91f16700Schasinglulu /* Global variables to be set in pm_client.c */
30*91f16700Schasinglulu extern const struct pm_proc *primary_proc;
31*91f16700Schasinglulu 
32*91f16700Schasinglulu #if defined(PLAT_zynqmp)
33*91f16700Schasinglulu enum pm_ret_status pm_set_suspend_mode(uint32_t mode);
34*91f16700Schasinglulu const struct pm_proc *pm_get_proc_by_node(enum pm_node_id nid);
35*91f16700Schasinglulu #endif /* PLAT_zynqmp */
36*91f16700Schasinglulu 
37*91f16700Schasinglulu #endif /* PM_CLIENT_H */
38