1 /**
2  * @file    emcc_regs.h
3  * @brief   Registers, Bit Masks and Bit Positions for the EMCC Peripheral Module.
4  * @note    This file is @generated.
5  * @ingroup emcc_registers
6  */
7 
8 /******************************************************************************
9  *
10  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by
11  * Analog Devices, Inc.),
12  * Copyright (C) 2023-2024 Analog Devices, Inc.
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 
28 #ifndef LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32690_INCLUDE_EMCC_REGS_H_
29 #define LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32690_INCLUDE_EMCC_REGS_H_
30 
31 /* **** Includes **** */
32 #include <stdint.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 #if defined (__ICCARM__)
39   #pragma system_include
40 #endif
41 
42 #if defined (__CC_ARM)
43   #pragma anon_unions
44 #endif
45 /// @cond
46 /*
47     If types are not defined elsewhere (CMSIS) define them here
48 */
49 #ifndef __IO
50 #define __IO volatile
51 #endif
52 #ifndef __I
53 #define __I  volatile const
54 #endif
55 #ifndef __O
56 #define __O  volatile
57 #endif
58 #ifndef __R
59 #define __R  volatile const
60 #endif
61 /// @endcond
62 
63 /* **** Definitions **** */
64 
65 /**
66  * @ingroup     emcc
67  * @defgroup    emcc_registers EMCC_Registers
68  * @brief       Registers, Bit Masks and Bit Positions for the EMCC Peripheral Module.
69  * @details     External Memory Cache Controller Registers.
70  */
71 
72 /**
73  * @ingroup emcc_registers
74  * Structure type to access the EMCC Registers.
75  */
76 typedef struct {
77     __I  uint32_t info;                 /**< <tt>\b 0x0000:</tt> EMCC INFO Register */
78     __I  uint32_t sz;                   /**< <tt>\b 0x0004:</tt> EMCC SZ Register */
79     __R  uint32_t rsv_0x8_0xff[62];
80     __IO uint32_t ctrl;                 /**< <tt>\b 0x0100:</tt> EMCC CTRL Register */
81     __R  uint32_t rsv_0x104_0x6ff[383];
82     __IO uint32_t invalidate;           /**< <tt>\b 0x0700:</tt> EMCC INVALIDATE Register */
83 } mxc_emcc_regs_t;
84 
85 /* Register offsets for module EMCC */
86 /**
87  * @ingroup    emcc_registers
88  * @defgroup   EMCC_Register_Offsets Register Offsets
89  * @brief      EMCC Peripheral Register Offsets from the EMCC Base Peripheral Address.
90  * @{
91  */
92 #define MXC_R_EMCC_INFO                    ((uint32_t)0x00000000UL) /**< Offset from EMCC Base Address: <tt> 0x0000</tt> */
93 #define MXC_R_EMCC_SZ                      ((uint32_t)0x00000004UL) /**< Offset from EMCC Base Address: <tt> 0x0004</tt> */
94 #define MXC_R_EMCC_CTRL                    ((uint32_t)0x00000100UL) /**< Offset from EMCC Base Address: <tt> 0x0100</tt> */
95 #define MXC_R_EMCC_INVALIDATE              ((uint32_t)0x00000700UL) /**< Offset from EMCC Base Address: <tt> 0x0700</tt> */
96 /**@} end of group emcc_registers */
97 
98 /**
99  * @ingroup  emcc_registers
100  * @defgroup EMCC_INFO EMCC_INFO
101  * @brief    Cache ID Register.
102  * @{
103  */
104 #define MXC_F_EMCC_INFO_RELNUM_POS                     0 /**< INFO_RELNUM Position */
105 #define MXC_F_EMCC_INFO_RELNUM                         ((uint32_t)(0x3FUL << MXC_F_EMCC_INFO_RELNUM_POS)) /**< INFO_RELNUM Mask */
106 
107 #define MXC_F_EMCC_INFO_PARTNUM_POS                    6 /**< INFO_PARTNUM Position */
108 #define MXC_F_EMCC_INFO_PARTNUM                        ((uint32_t)(0xFUL << MXC_F_EMCC_INFO_PARTNUM_POS)) /**< INFO_PARTNUM Mask */
109 
110 #define MXC_F_EMCC_INFO_ID_POS                         10 /**< INFO_ID Position */
111 #define MXC_F_EMCC_INFO_ID                             ((uint32_t)(0x3FUL << MXC_F_EMCC_INFO_ID_POS)) /**< INFO_ID Mask */
112 
113 /**@} end of group EMCC_INFO_Register */
114 
115 /**
116  * @ingroup  emcc_registers
117  * @defgroup EMCC_SZ EMCC_SZ
118  * @brief    Memory Configuration Register.
119  * @{
120  */
121 #define MXC_F_EMCC_SZ_CCH_POS                          0 /**< SZ_CCH Position */
122 #define MXC_F_EMCC_SZ_CCH                              ((uint32_t)(0xFFFFUL << MXC_F_EMCC_SZ_CCH_POS)) /**< SZ_CCH Mask */
123 
124 #define MXC_F_EMCC_SZ_MEM_POS                          16 /**< SZ_MEM Position */
125 #define MXC_F_EMCC_SZ_MEM                              ((uint32_t)(0xFFFFUL << MXC_F_EMCC_SZ_MEM_POS)) /**< SZ_MEM Mask */
126 
127 /**@} end of group EMCC_SZ_Register */
128 
129 /**
130  * @ingroup  emcc_registers
131  * @defgroup EMCC_CTRL EMCC_CTRL
132  * @brief    Cache Control and Status Register.
133  * @{
134  */
135 #define MXC_F_EMCC_CTRL_EN_POS                         0 /**< CTRL_EN Position */
136 #define MXC_F_EMCC_CTRL_EN                             ((uint32_t)(0x1UL << MXC_F_EMCC_CTRL_EN_POS)) /**< CTRL_EN Mask */
137 
138 #define MXC_F_EMCC_CTRL_WRITE_ALLOC_POS                1 /**< CTRL_WRITE_ALLOC Position */
139 #define MXC_F_EMCC_CTRL_WRITE_ALLOC                    ((uint32_t)(0x1UL << MXC_F_EMCC_CTRL_WRITE_ALLOC_POS)) /**< CTRL_WRITE_ALLOC Mask */
140 
141 #define MXC_F_EMCC_CTRL_CWFST_DIS_POS                  2 /**< CTRL_CWFST_DIS Position */
142 #define MXC_F_EMCC_CTRL_CWFST_DIS                      ((uint32_t)(0x1UL << MXC_F_EMCC_CTRL_CWFST_DIS_POS)) /**< CTRL_CWFST_DIS Mask */
143 
144 #define MXC_F_EMCC_CTRL_RDY_POS                        16 /**< CTRL_RDY Position */
145 #define MXC_F_EMCC_CTRL_RDY                            ((uint32_t)(0x1UL << MXC_F_EMCC_CTRL_RDY_POS)) /**< CTRL_RDY Mask */
146 
147 /**@} end of group EMCC_CTRL_Register */
148 
149 /**
150  * @ingroup  emcc_registers
151  * @defgroup EMCC_INVALIDATE EMCC_INVALIDATE
152  * @brief    Invalidate All Cache Contents. Any time this register location is written
153  *           (regardless of the data value), the cache controller immediately begins
154  *           invalidating the entire contents of the cache memory. The cache will be in
155  *           bypass mode until the invalidate operation is complete. System software can
156  *           examine the Cache Ready bit (CACHE_CTRL.CACHE_RDY) to determine when the
157  *           invalidate operation is complete. Note that it is not necessary to disable the
158  *           cache controller prior to beginning this operation. Reads from this register
159  *           always return 0.
160  * @{
161  */
162 #define MXC_F_EMCC_INVALIDATE_IA_POS                   0 /**< INVALIDATE_IA Position */
163 #define MXC_F_EMCC_INVALIDATE_IA                       ((uint32_t)(0xFFFFFFFFUL << MXC_F_EMCC_INVALIDATE_IA_POS)) /**< INVALIDATE_IA Mask */
164 
165 /**@} end of group EMCC_INVALIDATE_Register */
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 
171 #endif // LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32690_INCLUDE_EMCC_REGS_H_
172