xref: /arm-trusted-firmware/plat/imx/common/sci/svc/pm/sci_pm_rpc.h (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700Schasinglulu /*
2*91f16700Schasinglulu  * Copyright (c) 2015-2018, ARM Limited and Contributors. All rights reserved.
3*91f16700Schasinglulu  *
4*91f16700Schasinglulu  * SPDX-License-Identifier: BSD-3-Clause
5*91f16700Schasinglulu  */
6*91f16700Schasinglulu 
7*91f16700Schasinglulu /*!
8*91f16700Schasinglulu  * Header file for the PM RPC implementation.
9*91f16700Schasinglulu  *
10*91f16700Schasinglulu  * @addtogroup PM_SVC
11*91f16700Schasinglulu  * @{
12*91f16700Schasinglulu  */
13*91f16700Schasinglulu 
14*91f16700Schasinglulu #ifndef SCI_PM_RPC_H
15*91f16700Schasinglulu #define SCI_PM_RPC_H
16*91f16700Schasinglulu 
17*91f16700Schasinglulu /* Includes */
18*91f16700Schasinglulu 
19*91f16700Schasinglulu /* Defines */
20*91f16700Schasinglulu 
21*91f16700Schasinglulu /*!
22*91f16700Schasinglulu  * @name Defines for RPC PM function calls
23*91f16700Schasinglulu  */
24*91f16700Schasinglulu /*@{*/
25*91f16700Schasinglulu #define PM_FUNC_UNKNOWN 0	/* Unknown function */
26*91f16700Schasinglulu #define PM_FUNC_SET_SYS_POWER_MODE 19U	/* Index for pm_set_sys_power_mode() RPC call */
27*91f16700Schasinglulu #define PM_FUNC_SET_PARTITION_POWER_MODE 1U	/* Index for pm_set_partition_power_mode() RPC call */
28*91f16700Schasinglulu #define PM_FUNC_GET_SYS_POWER_MODE 2U	/* Index for pm_get_sys_power_mode() RPC call */
29*91f16700Schasinglulu #define PM_FUNC_SET_RESOURCE_POWER_MODE 3U	/* Index for pm_set_resource_power_mode() RPC call */
30*91f16700Schasinglulu #define PM_FUNC_GET_RESOURCE_POWER_MODE 4U	/* Index for pm_get_resource_power_mode() RPC call */
31*91f16700Schasinglulu #define PM_FUNC_REQ_LOW_POWER_MODE 16U	/* Index for pm_req_low_power_mode() RPC call */
32*91f16700Schasinglulu #define PM_FUNC_REQ_CPU_LOW_POWER_MODE 20U	/* Index for pm_req_cpu_low_power_mode() RPC call */
33*91f16700Schasinglulu #define PM_FUNC_SET_CPU_RESUME_ADDR 17U	/* Index for pm_set_cpu_resume_addr() RPC call */
34*91f16700Schasinglulu #define PM_FUNC_SET_CPU_RESUME 21U	/* Index for pm_set_cpu_resume() RPC call */
35*91f16700Schasinglulu #define PM_FUNC_REQ_SYS_IF_POWER_MODE 18U	/* Index for pm_req_sys_if_power_mode() RPC call */
36*91f16700Schasinglulu #define PM_FUNC_SET_CLOCK_RATE 5U	/* Index for pm_set_clock_rate() RPC call */
37*91f16700Schasinglulu #define PM_FUNC_GET_CLOCK_RATE 6U	/* Index for pm_get_clock_rate() RPC call */
38*91f16700Schasinglulu #define PM_FUNC_CLOCK_ENABLE 7U	/* Index for pm_clock_enable() RPC call */
39*91f16700Schasinglulu #define PM_FUNC_SET_CLOCK_PARENT 14U	/* Index for pm_set_clock_parent() RPC call */
40*91f16700Schasinglulu #define PM_FUNC_GET_CLOCK_PARENT 15U	/* Index for pm_get_clock_parent() RPC call */
41*91f16700Schasinglulu #define PM_FUNC_RESET 13U	/* Index for pm_reset() RPC call */
42*91f16700Schasinglulu #define PM_FUNC_RESET_REASON 10U	/* Index for pm_reset_reason() RPC call */
43*91f16700Schasinglulu #define PM_FUNC_BOOT 8U		/* Index for pm_boot() RPC call */
44*91f16700Schasinglulu #define PM_FUNC_REBOOT 9U	/* Index for pm_reboot() RPC call */
45*91f16700Schasinglulu #define PM_FUNC_REBOOT_PARTITION 12U	/* Index for pm_reboot_partition() RPC call */
46*91f16700Schasinglulu #define PM_FUNC_CPU_START 11U	/* Index for pm_cpu_start() RPC call */
47*91f16700Schasinglulu /*@}*/
48*91f16700Schasinglulu 
49*91f16700Schasinglulu /* Types */
50*91f16700Schasinglulu 
51*91f16700Schasinglulu /* Functions */
52*91f16700Schasinglulu 
53*91f16700Schasinglulu /*!
54*91f16700Schasinglulu  * This function dispatches an incoming PM RPC request.
55*91f16700Schasinglulu  *
56*91f16700Schasinglulu  * @param[in]     caller_pt   caller partition
57*91f16700Schasinglulu  * @param[in]     msg         pointer to RPC message
58*91f16700Schasinglulu  */
59*91f16700Schasinglulu void pm_dispatch(sc_rm_pt_t caller_pt, sc_rpc_msg_t *msg);
60*91f16700Schasinglulu 
61*91f16700Schasinglulu /*!
62*91f16700Schasinglulu  * This function translates and dispatches an PM RPC request.
63*91f16700Schasinglulu  *
64*91f16700Schasinglulu  * @param[in]     ipc         IPC handle
65*91f16700Schasinglulu  * @param[in]     msg         pointer to RPC message
66*91f16700Schasinglulu  */
67*91f16700Schasinglulu void pm_xlate(sc_ipc_t ipc, sc_rpc_msg_t *msg);
68*91f16700Schasinglulu 
69*91f16700Schasinglulu #endif /* SCI_PM_RPC_H */
70*91f16700Schasinglulu 
71*91f16700Schasinglulu /**@}*/
72