xref: /btstack/port/renesas-ek-ra6m4a-da14531/e2-project/ra/fsp/src/bsp/mcu/all/bsp_register_protection.h (revision c30869498fb8e98c1408c9db0e7624f02f483b73)
1 /***********************************************************************************************************************
2  * Copyright [2020-2022] Renesas Electronics Corporation and/or its affiliates.  All Rights Reserved.
3  *
4  * This software and documentation are supplied by Renesas Electronics America Inc. and may only be used with products
5  * of Renesas Electronics Corp. and its affiliates ("Renesas").  No other uses are authorized.  Renesas products are
6  * sold pursuant to Renesas terms and conditions of sale.  Purchasers are solely responsible for the selection and use
7  * of Renesas products and Renesas assumes no liability.  No license, express or implied, to any intellectual property
8  * right is granted by Renesas. This software is protected under all applicable laws, including copyright laws. Renesas
9  * reserves the right to change or discontinue this software and/or this documentation. THE SOFTWARE AND DOCUMENTATION
10  * IS DELIVERED TO YOU "AS IS," AND RENESAS MAKES NO REPRESENTATIONS OR WARRANTIES, AND TO THE FULLEST EXTENT
11  * PERMISSIBLE UNDER APPLICABLE LAW, DISCLAIMS ALL WARRANTIES, WHETHER EXPLICITLY OR IMPLICITLY, INCLUDING WARRANTIES
12  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT, WITH RESPECT TO THE SOFTWARE OR
13  * DOCUMENTATION.  RENESAS SHALL HAVE NO LIABILITY ARISING OUT OF ANY SECURITY VULNERABILITY OR BREACH.  TO THE MAXIMUM
14  * EXTENT PERMITTED BY LAW, IN NO EVENT WILL RENESAS BE LIABLE TO YOU IN CONNECTION WITH THE SOFTWARE OR DOCUMENTATION
15  * (OR ANY PERSON OR ENTITY CLAIMING RIGHTS DERIVED FROM YOU) FOR ANY LOSS, DAMAGES, OR CLAIMS WHATSOEVER, INCLUDING,
16  * WITHOUT LIMITATION, ANY DIRECT, CONSEQUENTIAL, SPECIAL, INDIRECT, PUNITIVE, OR INCIDENTAL DAMAGES; ANY LOST PROFITS,
17  * OTHER ECONOMIC DAMAGE, PROPERTY DAMAGE, OR PERSONAL INJURY; AND EVEN IF RENESAS HAS BEEN ADVISED OF THE POSSIBILITY
18  * OF SUCH LOSS, DAMAGES, CLAIMS OR COSTS.
19  **********************************************************************************************************************/
20 
21 #ifndef BSP_REGISTER_PROTECTION_H
22 #define BSP_REGISTER_PROTECTION_H
23 
24 /** Common macro for FSP header files. There is also a corresponding FSP_FOOTER macro at the end of this file. */
25 FSP_HEADER
26 
27 /***********************************************************************************************************************
28  * Macro definitions
29  **********************************************************************************************************************/
30 
31 /***********************************************************************************************************************
32  * Typedef definitions
33  **********************************************************************************************************************/
34 
35 /*******************************************************************************************************************//**
36  * @addtogroup BSP_MCU
37  * @{
38  **********************************************************************************************************************/
39 
40 /** The different types of registers that can be protected. */
41 typedef enum e_bsp_reg_protect
42 {
43     /** Enables writing to the registers related to the clock generation circuit. */
44     BSP_REG_PROTECT_CGC = 0,
45 
46     /** Enables writing to the registers related to operating modes, low power consumption, and battery backup
47      * function. */
48     BSP_REG_PROTECT_OM_LPC_BATT,
49 
50     /** Enables writing to the registers related to the LVD: LVCMPCR, LVDLVLR, LVD1CR0, LVD1CR1, LVD1SR, LVD2CR0,
51      * LVD2CR1, LVD2SR. */
52     BSP_REG_PROTECT_LVD,
53 
54     /** Enables writing to the registers related to the security function. */
55     BSP_REG_PROTECT_SAR,
56 } bsp_reg_protect_t;
57 
58 /** @} (end addtogroup BSP_MCU) */
59 
60 /***********************************************************************************************************************
61  * Exported global variables
62  **********************************************************************************************************************/
63 
64 /***********************************************************************************************************************
65  * Exported global functions (to be accessed by other files)
66  **********************************************************************************************************************/
67 
68 /* Public functions defined in bsp.h */
69 void bsp_register_protect_open(void);  // Used internally by BSP
70 
71 /** Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
72 FSP_FOOTER
73 
74 #endif
75