xref: /btstack/port/renesas-tb-s1ja-cc256x/template/btstack_example/synergy/ssp/src/bsp/mcu/s1ja/bsp_cache.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_cache.h
21 * Description  : This module implements cache functions.
22 ***********************************************************************************************************************/
23 
24 #ifndef BSP_CACHE_H_
25 #define BSP_CACHE_H_
26 
27 /***********************************************************************************************************************
28 Macro definitions
29 ***********************************************************************************************************************/
30 
31 /*******************************************************************************************************************//**
32  * @ingroup BSP_MCU_S1JA
33  * @defgroup BSP_MCU_CACHE_S1JA Cache Functions
34  *
35  * This module implements cache functions.
36  *
37  * @{
38  **********************************************************************************************************************/
39 
40 /***********************************************************************************************************************
41 Typedef definitions
42 ***********************************************************************************************************************/
43 /** Cache enum. Passed into cache functions such as R_BSP_CacheOff() and R_BSP_CacheSet. */
44 typedef enum e_bsp_cache_state
45 {
46     BSP_CACHE_STATE_OFF,
47     BSP_CACHE_STATE_ON,
48 } bsp_cache_state_t;
49 
50 typedef uint32_t bsp_cache_frequency_t;
51 
52 /** @} (end defgroup BSP_MCU_CACHE_S1JA) */
53 
54 /***********************************************************************************************************************
55 Exported global variables
56 ***********************************************************************************************************************/
57 
58 /***********************************************************************************************************************
59 Exported global functions (to be accessed by other files)
60 ***********************************************************************************************************************/
61 
62 /* Public functions defined in bsp.h */
63 
64 #endif /* BSP_CACHE_H_ */
65 
66 
67