xref: /btstack/port/renesas-tb-s1ja-cc256x/template/btstack_example/synergy/ssp/src/bsp/mcu/all/bsp_mcu_api.h (revision 3b5c872a8c45689e8cc17891f01530f5aa5e911c)
1 /***********************************************************************************************************************
2  * Copyright [2015-2017] Renesas Electronics Corporation and/or its licensors. All Rights Reserved.
3  *
4  * This file is part of Renesas SynergyTM Software Package (SSP)
5  *
6  * The contents of this file (the "contents") are proprietary and confidential to Renesas Electronics Corporation
7  * and/or its licensors ("Renesas") and subject to statutory and contractual protections.
8  *
9  * This file is subject to a Renesas SSP license agreement. Unless otherwise agreed in an SSP license agreement with
10  * Renesas: 1) you may not use, copy, modify, distribute, display, or perform the contents; 2) you may not use any name
11  * or mark of Renesas for advertising or publicity purposes or in connection with your use of the contents; 3) RENESAS
12  * MAKES NO WARRANTY OR REPRESENTATIONS ABOUT THE SUITABILITY OF THE CONTENTS FOR ANY PURPOSE; THE CONTENTS ARE PROVIDED
13  * "AS IS" WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
14  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT; AND 4) RENESAS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, OR
15  * CONSEQUENTIAL DAMAGES, INCLUDING DAMAGES RESULTING FROM LOSS OF USE, DATA, OR PROJECTS, WHETHER IN AN ACTION OF
16  * CONTRACT OR TORT, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE CONTENTS. Third-party contents
17  * included in this file may be subject to different terms.
18  **********************************************************************************************************************/
19 /***********************************************************************************************************************
20 * File Name    : bsp_mcu_api.h
21 * Description  : BSP API function prototypes.
22 ***********************************************************************************************************************/
23 
24 
25 #ifndef BSP_MCU_API_H_
26 #define BSP_MCU_API_H_
27 
28 /* Common macro for SSP header files. There is also a corresponding SSP_FOOTER macro at the end of this file. */
29 SSP_HEADER
30 
31 void        R_BSP_RegisterProtectEnable(bsp_reg_protect_t regs_to_protect);
32 void        R_BSP_RegisterProtectDisable(bsp_reg_protect_t regs_to_protect);
33 void        R_BSP_SoftwareLockInit(bsp_lock_t * p_lock);
34 ssp_err_t   R_BSP_SoftwareLock(bsp_lock_t * p_lock);
35 void        R_BSP_SoftwareUnlock(bsp_lock_t * p_lock);
36 ssp_err_t   R_BSP_HardwareLock(ssp_feature_t const * const p_feature);
37 void        R_BSP_HardwareUnlock(ssp_feature_t const * const p_feature);
38 ssp_err_t   R_BSP_GroupIrqWrite(bsp_grp_irq_t irq,  void (* p_callback)(bsp_grp_irq_t irq));
39 void        R_BSP_IrqStatusClear(IRQn_Type irq);
40 ssp_err_t   R_BSP_LedsGet(bsp_leds_t * p_leds);
41 void        R_BSP_SoftwareDelay(uint32_t delay, bsp_delay_units_t units);
42 ssp_err_t   R_BSP_ModuleStop(ssp_feature_t const * const feature);
43 ssp_err_t   R_BSP_ModuleStopAlways(ssp_feature_t const * const p_feature);
44 ssp_err_t   R_BSP_ModuleStart(ssp_feature_t const * const feature);
45 ssp_err_t   R_BSP_ModuleStateGet(ssp_feature_t const * const p_feature, bool * const p_stop);
46 ssp_err_t   R_BSP_VersionGet(ssp_version_t * p_version);
47 ssp_err_t   R_BSP_CacheOff(bsp_cache_state_t * p_state);
48 ssp_err_t   R_BSP_CacheSet(bsp_cache_state_t state);
49 
50 /* Common macro for SSP header files. There is also a corresponding SSP_HEADER macro at the top of this file. */
51 SSP_FOOTER
52 
53 #endif /* BSP_MCU_API_H_ */
54