1 /***********************************************************************************************//**
2  * \file cybsp_dsram.h
3  *
4  * \brief
5  * Basic API for DSRAM support.
6  *
7  ***************************************************************************************************
8  * \copyright
9  * Copyright 2018-2021 Cypress Semiconductor Corporation (an Infineon company) or
10  * an affiliate of Cypress Semiconductor Corporation
11  *
12  * SPDX-License-Identifier: Apache-2.0
13  *
14  * Licensed under the Apache License, Version 2.0 (the "License");
15  * you may not use this file except in compliance with the License.
16  * You may obtain a copy of the License at
17  *
18  *     http://www.apache.org/licenses/LICENSE-2.0
19  *
20  * Unless required by applicable law or agreed to in writing, software
21  * distributed under the License is distributed on an "AS IS" BASIS,
22  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23  * See the License for the specific language governing permissions and
24  * limitations under the License.
25  **************************************************************************************************/
26 
27 #pragma once
28 
29 #include "cy_result.h"
30 #include "cybsp_types.h"
31 
32 #if defined(__cplusplus)
33 extern "C" {
34 #endif
35 
36 /**
37  * \addtogroup group_bsp_dsram_functions Functions
38  * \{
39  * All functions exposed by the board.
40  */
41 
42 /**
43  * \brief Prepares the system to handle warm boot.
44  */
45 void cybsp_syspm_do_warmboot(void);
46 
47 /**
48  * \brief Initializes the deepsleep ram setup.
49  * \returns CY_RSLT_SUCCESS if the board is successfully initialized, if there is
50  *          a problem initializing any hardware it returns an error code specific
51  *          to the hardware module that had a problem.
52  */
53 cy_rslt_t cybsp_syspm_dsram_init(void);
54 
55 
56 extern cy_stc_syspm_warmboot_entrypoint_t syspmBspDeepSleepEntryPoint; ///< DS entry point
57 
58 /** \} group_bsp_dsram_functions */
59 
60 #ifdef __cplusplus
61 }
62 #endif // __cplusplus
63