1 /**
2  * @file    pt_regs.h
3  * @brief   Registers, Bit Masks and Bit Positions for the PT Peripheral Module.
4  * @note    This file is @generated.
5  */
6 
7 /******************************************************************************
8  *
9  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by
10  * Analog Devices, Inc.),
11  * Copyright (C) 2023-2024 Analog Devices, Inc.
12  *
13  * Licensed under the Apache License, Version 2.0 (the "License");
14  * you may not use this file except in compliance with the License.
15  * You may obtain a copy of the License at
16  *
17  *     http://www.apache.org/licenses/LICENSE-2.0
18  *
19  * Unless required by applicable law or agreed to in writing, software
20  * distributed under the License is distributed on an "AS IS" BASIS,
21  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22  * See the License for the specific language governing permissions and
23  * limitations under the License.
24  *
25  ******************************************************************************/
26 
27 #ifndef LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32570_INCLUDE_PT_REGS_H_
28 #define LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32570_INCLUDE_PT_REGS_H_
29 
30 /* **** Includes **** */
31 #include <stdint.h>
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 #if defined (__ICCARM__)
38   #pragma system_include
39 #endif
40 
41 #if defined (__CC_ARM)
42   #pragma anon_unions
43 #endif
44 /// @cond
45 /*
46     If types are not defined elsewhere (CMSIS) define them here
47 */
48 #ifndef __IO
49 #define __IO volatile
50 #endif
51 #ifndef __I
52 #define __I  volatile const
53 #endif
54 #ifndef __O
55 #define __O  volatile
56 #endif
57 #ifndef __R
58 #define __R  volatile const
59 #endif
60 /// @endcond
61 
62 /* **** Definitions **** */
63 
64 /**
65  * @ingroup     pt
66  * @defgroup    pt_registers PT_Registers
67  * @brief       Registers, Bit Masks and Bit Positions for the PT Peripheral Module.
68  * @details     Pulse Train
69  */
70 
71 /**
72  * @ingroup pt_registers
73  * Structure type to access the PT Registers.
74  */
75 typedef struct {
76     __IO uint32_t rate_length;          /**< <tt>\b 0x0000:</tt> PT RATE_LENGTH Register */
77     __IO uint32_t train;                /**< <tt>\b 0x0004:</tt> PT TRAIN Register */
78     __IO uint32_t loop;                 /**< <tt>\b 0x0008:</tt> PT LOOP Register */
79     __IO uint32_t restart;              /**< <tt>\b 0x000C:</tt> PT RESTART Register */
80 } mxc_pt_regs_t;
81 
82 /* Register offsets for module PT */
83 /**
84  * @ingroup    pt_registers
85  * @defgroup   PT_Register_Offsets Register Offsets
86  * @brief      PT Peripheral Register Offsets from the PT Base Peripheral Address.
87  * @{
88  */
89 #define MXC_R_PT_RATE_LENGTH               ((uint32_t)0x00000000UL) /**< Offset from PT Base Address: <tt> 0x0000</tt> */
90 #define MXC_R_PT_TRAIN                     ((uint32_t)0x00000004UL) /**< Offset from PT Base Address: <tt> 0x0004</tt> */
91 #define MXC_R_PT_LOOP                      ((uint32_t)0x00000008UL) /**< Offset from PT Base Address: <tt> 0x0008</tt> */
92 #define MXC_R_PT_RESTART                   ((uint32_t)0x0000000CUL) /**< Offset from PT Base Address: <tt> 0x000C</tt> */
93 /**@} end of group pt_registers */
94 
95 /**
96  * @ingroup  pt_registers
97  * @defgroup PT_RATE_LENGTH PT_RATE_LENGTH
98  * @brief    Pulse Train Configuration
99  * @{
100  */
101 #define MXC_F_PT_RATE_LENGTH_RATE_CONTROL_POS          0 /**< RATE_LENGTH_RATE_CONTROL Position */
102 #define MXC_F_PT_RATE_LENGTH_RATE_CONTROL              ((uint32_t)(0x7FFFFFFUL << MXC_F_PT_RATE_LENGTH_RATE_CONTROL_POS)) /**< RATE_LENGTH_RATE_CONTROL Mask */
103 
104 #define MXC_F_PT_RATE_LENGTH_MODE_POS                  27 /**< RATE_LENGTH_MODE Position */
105 #define MXC_F_PT_RATE_LENGTH_MODE                      ((uint32_t)(0x1FUL << MXC_F_PT_RATE_LENGTH_MODE_POS)) /**< RATE_LENGTH_MODE Mask */
106 #define MXC_V_PT_RATE_LENGTH_MODE_32_BIT               ((uint32_t)0x0UL) /**< RATE_LENGTH_MODE_32_BIT Value */
107 #define MXC_S_PT_RATE_LENGTH_MODE_32_BIT               (MXC_V_PT_RATE_LENGTH_MODE_32_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_32_BIT Setting */
108 #define MXC_V_PT_RATE_LENGTH_MODE_SQUARE_WAVE          ((uint32_t)0x1UL) /**< RATE_LENGTH_MODE_SQUARE_WAVE Value */
109 #define MXC_S_PT_RATE_LENGTH_MODE_SQUARE_WAVE          (MXC_V_PT_RATE_LENGTH_MODE_SQUARE_WAVE << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_SQUARE_WAVE Setting */
110 #define MXC_V_PT_RATE_LENGTH_MODE_2_BIT                ((uint32_t)0x2UL) /**< RATE_LENGTH_MODE_2_BIT Value */
111 #define MXC_S_PT_RATE_LENGTH_MODE_2_BIT                (MXC_V_PT_RATE_LENGTH_MODE_2_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_2_BIT Setting */
112 #define MXC_V_PT_RATE_LENGTH_MODE_3_BIT                ((uint32_t)0x3UL) /**< RATE_LENGTH_MODE_3_BIT Value */
113 #define MXC_S_PT_RATE_LENGTH_MODE_3_BIT                (MXC_V_PT_RATE_LENGTH_MODE_3_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_3_BIT Setting */
114 #define MXC_V_PT_RATE_LENGTH_MODE_4_BIT                ((uint32_t)0x4UL) /**< RATE_LENGTH_MODE_4_BIT Value */
115 #define MXC_S_PT_RATE_LENGTH_MODE_4_BIT                (MXC_V_PT_RATE_LENGTH_MODE_4_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_4_BIT Setting */
116 #define MXC_V_PT_RATE_LENGTH_MODE_5_BIT                ((uint32_t)0x5UL) /**< RATE_LENGTH_MODE_5_BIT Value */
117 #define MXC_S_PT_RATE_LENGTH_MODE_5_BIT                (MXC_V_PT_RATE_LENGTH_MODE_5_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_5_BIT Setting */
118 #define MXC_V_PT_RATE_LENGTH_MODE_6_BIT                ((uint32_t)0x6UL) /**< RATE_LENGTH_MODE_6_BIT Value */
119 #define MXC_S_PT_RATE_LENGTH_MODE_6_BIT                (MXC_V_PT_RATE_LENGTH_MODE_6_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_6_BIT Setting */
120 #define MXC_V_PT_RATE_LENGTH_MODE_7_BIT                ((uint32_t)0x7UL) /**< RATE_LENGTH_MODE_7_BIT Value */
121 #define MXC_S_PT_RATE_LENGTH_MODE_7_BIT                (MXC_V_PT_RATE_LENGTH_MODE_7_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_7_BIT Setting */
122 #define MXC_V_PT_RATE_LENGTH_MODE_8_BIT                ((uint32_t)0x8UL) /**< RATE_LENGTH_MODE_8_BIT Value */
123 #define MXC_S_PT_RATE_LENGTH_MODE_8_BIT                (MXC_V_PT_RATE_LENGTH_MODE_8_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_8_BIT Setting */
124 #define MXC_V_PT_RATE_LENGTH_MODE_9_BIT                ((uint32_t)0x9UL) /**< RATE_LENGTH_MODE_9_BIT Value */
125 #define MXC_S_PT_RATE_LENGTH_MODE_9_BIT                (MXC_V_PT_RATE_LENGTH_MODE_9_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_9_BIT Setting */
126 #define MXC_V_PT_RATE_LENGTH_MODE_10_BIT               ((uint32_t)0xAUL) /**< RATE_LENGTH_MODE_10_BIT Value */
127 #define MXC_S_PT_RATE_LENGTH_MODE_10_BIT               (MXC_V_PT_RATE_LENGTH_MODE_10_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_10_BIT Setting */
128 #define MXC_V_PT_RATE_LENGTH_MODE_11_BIT               ((uint32_t)0xBUL) /**< RATE_LENGTH_MODE_11_BIT Value */
129 #define MXC_S_PT_RATE_LENGTH_MODE_11_BIT               (MXC_V_PT_RATE_LENGTH_MODE_11_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_11_BIT Setting */
130 #define MXC_V_PT_RATE_LENGTH_MODE_12_BIT               ((uint32_t)0xCUL) /**< RATE_LENGTH_MODE_12_BIT Value */
131 #define MXC_S_PT_RATE_LENGTH_MODE_12_BIT               (MXC_V_PT_RATE_LENGTH_MODE_12_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_12_BIT Setting */
132 #define MXC_V_PT_RATE_LENGTH_MODE_13_BIT               ((uint32_t)0xDUL) /**< RATE_LENGTH_MODE_13_BIT Value */
133 #define MXC_S_PT_RATE_LENGTH_MODE_13_BIT               (MXC_V_PT_RATE_LENGTH_MODE_13_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_13_BIT Setting */
134 #define MXC_V_PT_RATE_LENGTH_MODE_14_BIT               ((uint32_t)0xEUL) /**< RATE_LENGTH_MODE_14_BIT Value */
135 #define MXC_S_PT_RATE_LENGTH_MODE_14_BIT               (MXC_V_PT_RATE_LENGTH_MODE_14_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_14_BIT Setting */
136 #define MXC_V_PT_RATE_LENGTH_MODE_15_BIT               ((uint32_t)0xFUL) /**< RATE_LENGTH_MODE_15_BIT Value */
137 #define MXC_S_PT_RATE_LENGTH_MODE_15_BIT               (MXC_V_PT_RATE_LENGTH_MODE_15_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_15_BIT Setting */
138 #define MXC_V_PT_RATE_LENGTH_MODE_16_BIT               ((uint32_t)0x10UL) /**< RATE_LENGTH_MODE_16_BIT Value */
139 #define MXC_S_PT_RATE_LENGTH_MODE_16_BIT               (MXC_V_PT_RATE_LENGTH_MODE_16_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_16_BIT Setting */
140 #define MXC_V_PT_RATE_LENGTH_MODE_17_BIT               ((uint32_t)0x11UL) /**< RATE_LENGTH_MODE_17_BIT Value */
141 #define MXC_S_PT_RATE_LENGTH_MODE_17_BIT               (MXC_V_PT_RATE_LENGTH_MODE_17_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_17_BIT Setting */
142 #define MXC_V_PT_RATE_LENGTH_MODE_18_BIT               ((uint32_t)0x12UL) /**< RATE_LENGTH_MODE_18_BIT Value */
143 #define MXC_S_PT_RATE_LENGTH_MODE_18_BIT               (MXC_V_PT_RATE_LENGTH_MODE_18_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_18_BIT Setting */
144 #define MXC_V_PT_RATE_LENGTH_MODE_19_BIT               ((uint32_t)0x13UL) /**< RATE_LENGTH_MODE_19_BIT Value */
145 #define MXC_S_PT_RATE_LENGTH_MODE_19_BIT               (MXC_V_PT_RATE_LENGTH_MODE_19_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_19_BIT Setting */
146 #define MXC_V_PT_RATE_LENGTH_MODE_20_BIT               ((uint32_t)0x14UL) /**< RATE_LENGTH_MODE_20_BIT Value */
147 #define MXC_S_PT_RATE_LENGTH_MODE_20_BIT               (MXC_V_PT_RATE_LENGTH_MODE_20_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_20_BIT Setting */
148 #define MXC_V_PT_RATE_LENGTH_MODE_21_BIT               ((uint32_t)0x15UL) /**< RATE_LENGTH_MODE_21_BIT Value */
149 #define MXC_S_PT_RATE_LENGTH_MODE_21_BIT               (MXC_V_PT_RATE_LENGTH_MODE_21_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_21_BIT Setting */
150 #define MXC_V_PT_RATE_LENGTH_MODE_22_BIT               ((uint32_t)0x16UL) /**< RATE_LENGTH_MODE_22_BIT Value */
151 #define MXC_S_PT_RATE_LENGTH_MODE_22_BIT               (MXC_V_PT_RATE_LENGTH_MODE_22_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_22_BIT Setting */
152 #define MXC_V_PT_RATE_LENGTH_MODE_23_BIT               ((uint32_t)0x17UL) /**< RATE_LENGTH_MODE_23_BIT Value */
153 #define MXC_S_PT_RATE_LENGTH_MODE_23_BIT               (MXC_V_PT_RATE_LENGTH_MODE_23_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_23_BIT Setting */
154 #define MXC_V_PT_RATE_LENGTH_MODE_24_BIT               ((uint32_t)0x18UL) /**< RATE_LENGTH_MODE_24_BIT Value */
155 #define MXC_S_PT_RATE_LENGTH_MODE_24_BIT               (MXC_V_PT_RATE_LENGTH_MODE_24_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_24_BIT Setting */
156 #define MXC_V_PT_RATE_LENGTH_MODE_25_BIT               ((uint32_t)0x19UL) /**< RATE_LENGTH_MODE_25_BIT Value */
157 #define MXC_S_PT_RATE_LENGTH_MODE_25_BIT               (MXC_V_PT_RATE_LENGTH_MODE_25_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_25_BIT Setting */
158 #define MXC_V_PT_RATE_LENGTH_MODE_26_BIT               ((uint32_t)0x1AUL) /**< RATE_LENGTH_MODE_26_BIT Value */
159 #define MXC_S_PT_RATE_LENGTH_MODE_26_BIT               (MXC_V_PT_RATE_LENGTH_MODE_26_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_26_BIT Setting */
160 #define MXC_V_PT_RATE_LENGTH_MODE_27_BIT               ((uint32_t)0x1BUL) /**< RATE_LENGTH_MODE_27_BIT Value */
161 #define MXC_S_PT_RATE_LENGTH_MODE_27_BIT               (MXC_V_PT_RATE_LENGTH_MODE_27_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_27_BIT Setting */
162 #define MXC_V_PT_RATE_LENGTH_MODE_28_BIT               ((uint32_t)0x1CUL) /**< RATE_LENGTH_MODE_28_BIT Value */
163 #define MXC_S_PT_RATE_LENGTH_MODE_28_BIT               (MXC_V_PT_RATE_LENGTH_MODE_28_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_28_BIT Setting */
164 #define MXC_V_PT_RATE_LENGTH_MODE_29_BIT               ((uint32_t)0x1DUL) /**< RATE_LENGTH_MODE_29_BIT Value */
165 #define MXC_S_PT_RATE_LENGTH_MODE_29_BIT               (MXC_V_PT_RATE_LENGTH_MODE_29_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_29_BIT Setting */
166 #define MXC_V_PT_RATE_LENGTH_MODE_30_BIT               ((uint32_t)0x1EUL) /**< RATE_LENGTH_MODE_30_BIT Value */
167 #define MXC_S_PT_RATE_LENGTH_MODE_30_BIT               (MXC_V_PT_RATE_LENGTH_MODE_30_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_30_BIT Setting */
168 #define MXC_V_PT_RATE_LENGTH_MODE_31_BIT               ((uint32_t)0x1FUL) /**< RATE_LENGTH_MODE_31_BIT Value */
169 #define MXC_S_PT_RATE_LENGTH_MODE_31_BIT               (MXC_V_PT_RATE_LENGTH_MODE_31_BIT << MXC_F_PT_RATE_LENGTH_MODE_POS) /**< RATE_LENGTH_MODE_31_BIT Setting */
170 
171 /**@} end of group PT_RATE_LENGTH_Register */
172 
173 /**
174  * @ingroup  pt_registers
175  * @defgroup PT_LOOP PT_LOOP
176  * @brief    Pulse Train Loop Count
177  * @{
178  */
179 #define MXC_F_PT_LOOP_COUNT_POS                        0 /**< LOOP_COUNT Position */
180 #define MXC_F_PT_LOOP_COUNT                            ((uint32_t)(0xFFFFUL << MXC_F_PT_LOOP_COUNT_POS)) /**< LOOP_COUNT Mask */
181 
182 #define MXC_F_PT_LOOP_DELAY_POS                        16 /**< LOOP_DELAY Position */
183 #define MXC_F_PT_LOOP_DELAY                            ((uint32_t)(0xFFFUL << MXC_F_PT_LOOP_DELAY_POS)) /**< LOOP_DELAY Mask */
184 
185 /**@} end of group PT_LOOP_Register */
186 
187 /**
188  * @ingroup  pt_registers
189  * @defgroup PT_RESTART PT_RESTART
190  * @brief     Pulse Train Auto-Restart Configuration.
191  * @{
192  */
193 #define MXC_F_PT_RESTART_PT_X_SELECT_POS               0 /**< RESTART_PT_X_SELECT Position */
194 #define MXC_F_PT_RESTART_PT_X_SELECT                   ((uint32_t)(0x1FUL << MXC_F_PT_RESTART_PT_X_SELECT_POS)) /**< RESTART_PT_X_SELECT Mask */
195 
196 #define MXC_F_PT_RESTART_ON_PT_X_LOOP_EXIT_POS         7 /**< RESTART_ON_PT_X_LOOP_EXIT Position */
197 #define MXC_F_PT_RESTART_ON_PT_X_LOOP_EXIT             ((uint32_t)(0x1UL << MXC_F_PT_RESTART_ON_PT_X_LOOP_EXIT_POS)) /**< RESTART_ON_PT_X_LOOP_EXIT Mask */
198 
199 #define MXC_F_PT_RESTART_PT_Y_SELECT_POS               8 /**< RESTART_PT_Y_SELECT Position */
200 #define MXC_F_PT_RESTART_PT_Y_SELECT                   ((uint32_t)(0x1FUL << MXC_F_PT_RESTART_PT_Y_SELECT_POS)) /**< RESTART_PT_Y_SELECT Mask */
201 
202 #define MXC_F_PT_RESTART_ON_PT_Y_LOOP_EXIT_POS         15 /**< RESTART_ON_PT_Y_LOOP_EXIT Position */
203 #define MXC_F_PT_RESTART_ON_PT_Y_LOOP_EXIT             ((uint32_t)(0x1UL << MXC_F_PT_RESTART_ON_PT_Y_LOOP_EXIT_POS)) /**< RESTART_ON_PT_Y_LOOP_EXIT Mask */
204 
205 /**@} end of group PT_RESTART_Register */
206 
207 #ifdef __cplusplus
208 }
209 #endif
210 
211 #endif // LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32570_INCLUDE_PT_REGS_H_
212