xref: /optee_os/core/arch/arm/include/sm/pm.h (revision b1469ba0bfd0371eb52bd50f5c52eeda7a8f5f1e)
1 /*
2  * Copyright 2017 NXP
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef SM_PM_H
29 #define SM_PM_H
30 #include <stdint.h>
31 #include <types_ext.h>
32 
33 struct sm_pm_ctx {
34 	uint32_t sp;
35 	paddr_t cpu_resume_addr;
36 	uint32_t suspend_regs[16];
37 };
38 
39 /* suspend/resume core functions */
40 void sm_pm_cpu_suspend_save(struct sm_pm_ctx *ptr, uint32_t sp);
41 void sm_pm_cpu_do_suspend(uint32_t *ptr);
42 void sm_pm_cpu_do_resume(void);
43 
44 /*
45  * Exported to platform suspend, arg will be passed to fn as r0
46  * Return value: 0  - cpu resumed from suspended state.
47  *               -1 - cpu not suspended.
48  */
49 int sm_pm_cpu_suspend(uint32_t arg, int (*fn)(uint32_t));
50 #endif
51