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