HPM SDK
HPMicro Software Development Kit
hpm_sdm_regs.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2025 HPMicro
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  */
7 
8 
9 #ifndef HPM_SDM_H
10 #define HPM_SDM_H
11 
12 typedef struct {
13  __RW uint32_t CTRL; /* 0x0: SDM control register */
14  __RW uint32_t INT_EN; /* 0x4: Interrupt enable register. */
15  __R uint32_t STATUS; /* 0x8: Status Registers */
16  __R uint8_t RESERVED0[4]; /* 0xC - 0xF: Reserved */
17  struct {
18  __RW uint32_t SDFIFOCTRL; /* 0x10: Data FIFO Path Control Register */
19  __RW uint32_t SDCTRLP; /* 0x14: Data Path Control Primary Register */
20  __RW uint32_t SDCTRLE; /* 0x18: Data Path Control Extra Register */
21  __RW uint32_t SDST; /* 0x1C: Data Path Status */
22  __R uint32_t SDATA; /* 0x20: Data */
23  __R uint32_t SDFIFO; /* 0x24: FIFO Data */
24  __R uint32_t SCAMP; /* 0x28: instant Amplitude Results */
25  __RW uint32_t SCHTL; /* 0x2C: Amplitude Threshold for High Limit */
26  __RW uint32_t SCHTLZ; /* 0x30: Amplitude Threshold for zero crossing */
27  __RW uint32_t SCLLT; /* 0x34: Amplitude Threshold for low limit */
28  __RW uint32_t SCCTRL; /* 0x38: Amplitude Path Control */
29  __RW uint32_t SCST; /* 0x3C: Amplitude Path Status */
30  __R uint8_t RESERVED0[16]; /* 0x40 - 0x4F: Reserved */
31  } CH[4];
32 } SDM_Type;
33 
34 
35 /* Bitfield definition for register: CTRL */
36 /*
37  * SFTRST (RW)
38  *
39  * software reset the module if asserted to be1’b1.
40  */
41 #define SDM_CTRL_SFTRST_MASK (0x80000000UL)
42 #define SDM_CTRL_SFTRST_SHIFT (31U)
43 #define SDM_CTRL_SFTRST_SET(x) (((uint32_t)(x) << SDM_CTRL_SFTRST_SHIFT) & SDM_CTRL_SFTRST_MASK)
44 #define SDM_CTRL_SFTRST_GET(x) (((uint32_t)(x) & SDM_CTRL_SFTRST_MASK) >> SDM_CTRL_SFTRST_SHIFT)
45 
46 /*
47  * CHMD (RW)
48  *
49  * Channel Rcv mode
50  * Bits[2:0] for Ch0.
51  * Bits[5:3] for Ch1
52  * Bits[8:6] for Ch2
53  * Bits[11:9] for Ch3
54  * 3'b000: Capture at posedge of MCLK
55  * 3'b001: Capture at both posedge and negedge of MCLK
56  * 3'b010: Manchestor Mode
57  * 3'b011: Capture at negedge of MCLK
58  * 3'b100: Capture at every other posedge of MCLK
59  * 3'b101: Capture at every other negedge of MCLK
60  * Others: Undefined
61  */
62 #define SDM_CTRL_CHMD_MASK (0x3FFC000UL)
63 #define SDM_CTRL_CHMD_SHIFT (14U)
64 #define SDM_CTRL_CHMD_SET(x) (((uint32_t)(x) << SDM_CTRL_CHMD_SHIFT) & SDM_CTRL_CHMD_MASK)
65 #define SDM_CTRL_CHMD_GET(x) (((uint32_t)(x) & SDM_CTRL_CHMD_MASK) >> SDM_CTRL_CHMD_SHIFT)
66 
67 /*
68  * SYNC_MCLK (RW)
69  *
70  * Asserted to double sync the mclk input pin before its usage inside the module
71  */
72 #define SDM_CTRL_SYNC_MCLK_MASK (0x3C00U)
73 #define SDM_CTRL_SYNC_MCLK_SHIFT (10U)
74 #define SDM_CTRL_SYNC_MCLK_SET(x) (((uint32_t)(x) << SDM_CTRL_SYNC_MCLK_SHIFT) & SDM_CTRL_SYNC_MCLK_MASK)
75 #define SDM_CTRL_SYNC_MCLK_GET(x) (((uint32_t)(x) & SDM_CTRL_SYNC_MCLK_MASK) >> SDM_CTRL_SYNC_MCLK_SHIFT)
76 
77 /*
78  * SYNC_MDAT (RW)
79  *
80  * Asserted to double sync the mdat input pin before its usage inside the module
81  */
82 #define SDM_CTRL_SYNC_MDAT_MASK (0x3C0U)
83 #define SDM_CTRL_SYNC_MDAT_SHIFT (6U)
84 #define SDM_CTRL_SYNC_MDAT_SET(x) (((uint32_t)(x) << SDM_CTRL_SYNC_MDAT_SHIFT) & SDM_CTRL_SYNC_MDAT_MASK)
85 #define SDM_CTRL_SYNC_MDAT_GET(x) (((uint32_t)(x) & SDM_CTRL_SYNC_MDAT_MASK) >> SDM_CTRL_SYNC_MDAT_SHIFT)
86 
87 /*
88  * CH_EN (RW)
89  *
90  * Channel Enable
91  */
92 #define SDM_CTRL_CH_EN_MASK (0x3CU)
93 #define SDM_CTRL_CH_EN_SHIFT (2U)
94 #define SDM_CTRL_CH_EN_SET(x) (((uint32_t)(x) << SDM_CTRL_CH_EN_SHIFT) & SDM_CTRL_CH_EN_MASK)
95 #define SDM_CTRL_CH_EN_GET(x) (((uint32_t)(x) & SDM_CTRL_CH_EN_MASK) >> SDM_CTRL_CH_EN_SHIFT)
96 
97 /*
98  * IE (RW)
99  *
100  * Interrupt Enable
101  */
102 #define SDM_CTRL_IE_MASK (0x2U)
103 #define SDM_CTRL_IE_SHIFT (1U)
104 #define SDM_CTRL_IE_SET(x) (((uint32_t)(x) << SDM_CTRL_IE_SHIFT) & SDM_CTRL_IE_MASK)
105 #define SDM_CTRL_IE_GET(x) (((uint32_t)(x) & SDM_CTRL_IE_MASK) >> SDM_CTRL_IE_SHIFT)
106 
107 /* Bitfield definition for register: INT_EN */
108 /*
109  * CH3DRY (RW)
110  *
111  * Ch3 Data Ready interrupt enable.
112  */
113 #define SDM_INT_EN_CH3DRY_MASK (0x80U)
114 #define SDM_INT_EN_CH3DRY_SHIFT (7U)
115 #define SDM_INT_EN_CH3DRY_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH3DRY_SHIFT) & SDM_INT_EN_CH3DRY_MASK)
116 #define SDM_INT_EN_CH3DRY_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH3DRY_MASK) >> SDM_INT_EN_CH3DRY_SHIFT)
117 
118 /*
119  * CH2DRY (RW)
120  *
121  * Ch2 Data Ready interrupt enable
122  */
123 #define SDM_INT_EN_CH2DRY_MASK (0x40U)
124 #define SDM_INT_EN_CH2DRY_SHIFT (6U)
125 #define SDM_INT_EN_CH2DRY_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH2DRY_SHIFT) & SDM_INT_EN_CH2DRY_MASK)
126 #define SDM_INT_EN_CH2DRY_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH2DRY_MASK) >> SDM_INT_EN_CH2DRY_SHIFT)
127 
128 /*
129  * CH1DRY (RW)
130  *
131  * Ch1 Data Ready interrupt enable
132  */
133 #define SDM_INT_EN_CH1DRY_MASK (0x20U)
134 #define SDM_INT_EN_CH1DRY_SHIFT (5U)
135 #define SDM_INT_EN_CH1DRY_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH1DRY_SHIFT) & SDM_INT_EN_CH1DRY_MASK)
136 #define SDM_INT_EN_CH1DRY_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH1DRY_MASK) >> SDM_INT_EN_CH1DRY_SHIFT)
137 
138 /*
139  * CH0DRY (RW)
140  *
141  * Ch0 Data Ready interrupt enable
142  */
143 #define SDM_INT_EN_CH0DRY_MASK (0x10U)
144 #define SDM_INT_EN_CH0DRY_SHIFT (4U)
145 #define SDM_INT_EN_CH0DRY_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH0DRY_SHIFT) & SDM_INT_EN_CH0DRY_MASK)
146 #define SDM_INT_EN_CH0DRY_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH0DRY_MASK) >> SDM_INT_EN_CH0DRY_SHIFT)
147 
148 /*
149  * CH3ERR (RW)
150  *
151  * Ch3 Error interrupt enable.
152  */
153 #define SDM_INT_EN_CH3ERR_MASK (0x8U)
154 #define SDM_INT_EN_CH3ERR_SHIFT (3U)
155 #define SDM_INT_EN_CH3ERR_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH3ERR_SHIFT) & SDM_INT_EN_CH3ERR_MASK)
156 #define SDM_INT_EN_CH3ERR_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH3ERR_MASK) >> SDM_INT_EN_CH3ERR_SHIFT)
157 
158 /*
159  * CH2ERR (RW)
160  *
161  * Ch2 Error interrupt enable
162  */
163 #define SDM_INT_EN_CH2ERR_MASK (0x4U)
164 #define SDM_INT_EN_CH2ERR_SHIFT (2U)
165 #define SDM_INT_EN_CH2ERR_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH2ERR_SHIFT) & SDM_INT_EN_CH2ERR_MASK)
166 #define SDM_INT_EN_CH2ERR_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH2ERR_MASK) >> SDM_INT_EN_CH2ERR_SHIFT)
167 
168 /*
169  * CH1ERR (RW)
170  *
171  * Ch1 Error interrupt enable
172  */
173 #define SDM_INT_EN_CH1ERR_MASK (0x2U)
174 #define SDM_INT_EN_CH1ERR_SHIFT (1U)
175 #define SDM_INT_EN_CH1ERR_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH1ERR_SHIFT) & SDM_INT_EN_CH1ERR_MASK)
176 #define SDM_INT_EN_CH1ERR_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH1ERR_MASK) >> SDM_INT_EN_CH1ERR_SHIFT)
177 
178 /*
179  * CH0ERR (RW)
180  *
181  * Ch0 Error interrupt enable
182  */
183 #define SDM_INT_EN_CH0ERR_MASK (0x1U)
184 #define SDM_INT_EN_CH0ERR_SHIFT (0U)
185 #define SDM_INT_EN_CH0ERR_SET(x) (((uint32_t)(x) << SDM_INT_EN_CH0ERR_SHIFT) & SDM_INT_EN_CH0ERR_MASK)
186 #define SDM_INT_EN_CH0ERR_GET(x) (((uint32_t)(x) & SDM_INT_EN_CH0ERR_MASK) >> SDM_INT_EN_CH0ERR_SHIFT)
187 
188 /* Bitfield definition for register: STATUS */
189 /*
190  * CH3DRY (RO)
191  *
192  * Ch3 Data Ready.
193  * De-assert this bit by reading the data (or data fifo) registers.
194  */
195 #define SDM_STATUS_CH3DRY_MASK (0x80U)
196 #define SDM_STATUS_CH3DRY_SHIFT (7U)
197 #define SDM_STATUS_CH3DRY_GET(x) (((uint32_t)(x) & SDM_STATUS_CH3DRY_MASK) >> SDM_STATUS_CH3DRY_SHIFT)
198 
199 /*
200  * CH2DRY (RO)
201  *
202  * Ch2 Data Ready
203  */
204 #define SDM_STATUS_CH2DRY_MASK (0x40U)
205 #define SDM_STATUS_CH2DRY_SHIFT (6U)
206 #define SDM_STATUS_CH2DRY_GET(x) (((uint32_t)(x) & SDM_STATUS_CH2DRY_MASK) >> SDM_STATUS_CH2DRY_SHIFT)
207 
208 /*
209  * CH1DRY (RO)
210  *
211  * Ch1 Data Ready
212  */
213 #define SDM_STATUS_CH1DRY_MASK (0x20U)
214 #define SDM_STATUS_CH1DRY_SHIFT (5U)
215 #define SDM_STATUS_CH1DRY_GET(x) (((uint32_t)(x) & SDM_STATUS_CH1DRY_MASK) >> SDM_STATUS_CH1DRY_SHIFT)
216 
217 /*
218  * CH0DRY (RO)
219  *
220  * Ch0 Data Ready
221  */
222 #define SDM_STATUS_CH0DRY_MASK (0x10U)
223 #define SDM_STATUS_CH0DRY_SHIFT (4U)
224 #define SDM_STATUS_CH0DRY_GET(x) (((uint32_t)(x) & SDM_STATUS_CH0DRY_MASK) >> SDM_STATUS_CH0DRY_SHIFT)
225 
226 /*
227  * CH3ERR (RO)
228  *
229  * Ch3 Error.
230  * ORed together by channel related error signals and corresponding error interrupt enable signals.
231  * De-assert this bit by write-1-clear the corresponding error status bits in the channel status registers.
232  */
233 #define SDM_STATUS_CH3ERR_MASK (0x8U)
234 #define SDM_STATUS_CH3ERR_SHIFT (3U)
235 #define SDM_STATUS_CH3ERR_GET(x) (((uint32_t)(x) & SDM_STATUS_CH3ERR_MASK) >> SDM_STATUS_CH3ERR_SHIFT)
236 
237 /*
238  * CH2ERR (RO)
239  *
240  * Ch2 Error
241  */
242 #define SDM_STATUS_CH2ERR_MASK (0x4U)
243 #define SDM_STATUS_CH2ERR_SHIFT (2U)
244 #define SDM_STATUS_CH2ERR_GET(x) (((uint32_t)(x) & SDM_STATUS_CH2ERR_MASK) >> SDM_STATUS_CH2ERR_SHIFT)
245 
246 /*
247  * CH1ERR (RO)
248  *
249  * Ch1 Error
250  */
251 #define SDM_STATUS_CH1ERR_MASK (0x2U)
252 #define SDM_STATUS_CH1ERR_SHIFT (1U)
253 #define SDM_STATUS_CH1ERR_GET(x) (((uint32_t)(x) & SDM_STATUS_CH1ERR_MASK) >> SDM_STATUS_CH1ERR_SHIFT)
254 
255 /*
256  * CH0ERR (RO)
257  *
258  * Ch0 Error
259  */
260 #define SDM_STATUS_CH0ERR_MASK (0x1U)
261 #define SDM_STATUS_CH0ERR_SHIFT (0U)
262 #define SDM_STATUS_CH0ERR_GET(x) (((uint32_t)(x) & SDM_STATUS_CH0ERR_MASK) >> SDM_STATUS_CH0ERR_SHIFT)
263 
264 /* Bitfield definition for register of struct array CH: SDFIFOCTRL */
265 /*
266  * THRSH (RW)
267  *
268  * FIFO threshold (0,..,16) (fillings > threshold, then gen int)
269  */
270 #define SDM_CH_SDFIFOCTRL_THRSH_MASK (0x1F0U)
271 #define SDM_CH_SDFIFOCTRL_THRSH_SHIFT (4U)
272 #define SDM_CH_SDFIFOCTRL_THRSH_SET(x) (((uint32_t)(x) << SDM_CH_SDFIFOCTRL_THRSH_SHIFT) & SDM_CH_SDFIFOCTRL_THRSH_MASK)
273 #define SDM_CH_SDFIFOCTRL_THRSH_GET(x) (((uint32_t)(x) & SDM_CH_SDFIFOCTRL_THRSH_MASK) >> SDM_CH_SDFIFOCTRL_THRSH_SHIFT)
274 
275 /* Bitfield definition for register of struct array CH: SDCTRLP */
276 /*
277  * MANCH_THR (RW)
278  *
279  * Manchester Decoding threshold. 3/4 of PERIOD_MCLK[7:0]
280  */
281 #define SDM_CH_SDCTRLP_MANCH_THR_MASK (0xFE000000UL)
282 #define SDM_CH_SDCTRLP_MANCH_THR_SHIFT (25U)
283 #define SDM_CH_SDCTRLP_MANCH_THR_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_MANCH_THR_SHIFT) & SDM_CH_SDCTRLP_MANCH_THR_MASK)
284 #define SDM_CH_SDCTRLP_MANCH_THR_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_MANCH_THR_MASK) >> SDM_CH_SDCTRLP_MANCH_THR_SHIFT)
285 
286 /*
287  * WDOG_THR (RW)
288  *
289  * Watch dog threshold for channel failure of CLK halting
290  */
291 #define SDM_CH_SDCTRLP_WDOG_THR_MASK (0x1FE0000UL)
292 #define SDM_CH_SDCTRLP_WDOG_THR_SHIFT (17U)
293 #define SDM_CH_SDCTRLP_WDOG_THR_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_WDOG_THR_SHIFT) & SDM_CH_SDCTRLP_WDOG_THR_MASK)
294 #define SDM_CH_SDCTRLP_WDOG_THR_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_WDOG_THR_MASK) >> SDM_CH_SDCTRLP_WDOG_THR_SHIFT)
295 
296 /*
297  * DFFOVIE (RW)
298  *
299  * Ch Data FIFO overflow interrupt enable
300  */
301 #define SDM_CH_SDCTRLP_DFFOVIE_MASK (0x8000U)
302 #define SDM_CH_SDCTRLP_DFFOVIE_SHIFT (15U)
303 #define SDM_CH_SDCTRLP_DFFOVIE_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_DFFOVIE_SHIFT) & SDM_CH_SDCTRLP_DFFOVIE_MASK)
304 #define SDM_CH_SDCTRLP_DFFOVIE_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_DFFOVIE_MASK) >> SDM_CH_SDCTRLP_DFFOVIE_SHIFT)
305 
306 /*
307  * DSATIE (RW)
308  *
309  * Ch CIC Data Saturation Interrupt Enable
310  */
311 #define SDM_CH_SDCTRLP_DSATIE_MASK (0x4000U)
312 #define SDM_CH_SDCTRLP_DSATIE_SHIFT (14U)
313 #define SDM_CH_SDCTRLP_DSATIE_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_DSATIE_SHIFT) & SDM_CH_SDCTRLP_DSATIE_MASK)
314 #define SDM_CH_SDCTRLP_DSATIE_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_DSATIE_MASK) >> SDM_CH_SDCTRLP_DSATIE_SHIFT)
315 
316 /*
317  * DRIE (RW)
318  *
319  * Ch Data Ready Interrupt Enable
320  */
321 #define SDM_CH_SDCTRLP_DRIE_MASK (0x2000U)
322 #define SDM_CH_SDCTRLP_DRIE_SHIFT (13U)
323 #define SDM_CH_SDCTRLP_DRIE_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_DRIE_SHIFT) & SDM_CH_SDCTRLP_DRIE_MASK)
324 #define SDM_CH_SDCTRLP_DRIE_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_DRIE_MASK) >> SDM_CH_SDCTRLP_DRIE_SHIFT)
325 
326 /*
327  * SYNCSEL (RW)
328  *
329  * Select the PWM SYNC Source
330  */
331 #define SDM_CH_SDCTRLP_SYNCSEL_MASK (0x1F80U)
332 #define SDM_CH_SDCTRLP_SYNCSEL_SHIFT (7U)
333 #define SDM_CH_SDCTRLP_SYNCSEL_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_SYNCSEL_SHIFT) & SDM_CH_SDCTRLP_SYNCSEL_MASK)
334 #define SDM_CH_SDCTRLP_SYNCSEL_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_SYNCSEL_MASK) >> SDM_CH_SDCTRLP_SYNCSEL_SHIFT)
335 
336 /*
337  * FFSYNCCLREN (RW)
338  *
339  * Auto clear FIFO when a new SDSYNC event is found. Only valid when WTSYNCEN=1
340  */
341 #define SDM_CH_SDCTRLP_FFSYNCCLREN_MASK (0x40U)
342 #define SDM_CH_SDCTRLP_FFSYNCCLREN_SHIFT (6U)
343 #define SDM_CH_SDCTRLP_FFSYNCCLREN_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_FFSYNCCLREN_SHIFT) & SDM_CH_SDCTRLP_FFSYNCCLREN_MASK)
344 #define SDM_CH_SDCTRLP_FFSYNCCLREN_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_FFSYNCCLREN_MASK) >> SDM_CH_SDCTRLP_FFSYNCCLREN_SHIFT)
345 
346 /*
347  * WTSYNACLR (RW)
348  *
349  * 1: Asserted to Auto clear WTSYNFLG when the SDFFINT is gen
350  * 0: WTSYNFLG should be cleared manually by WTSYNMCLR
351  */
352 #define SDM_CH_SDCTRLP_WTSYNACLR_MASK (0x20U)
353 #define SDM_CH_SDCTRLP_WTSYNACLR_SHIFT (5U)
354 #define SDM_CH_SDCTRLP_WTSYNACLR_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_WTSYNACLR_SHIFT) & SDM_CH_SDCTRLP_WTSYNACLR_MASK)
355 #define SDM_CH_SDCTRLP_WTSYNACLR_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_WTSYNACLR_MASK) >> SDM_CH_SDCTRLP_WTSYNACLR_SHIFT)
356 
357 /*
358  * WTSYNMCLR (RW)
359  *
360  * 1: Manually clear WTSYNFLG. Auto-clear.
361  */
362 #define SDM_CH_SDCTRLP_WTSYNMCLR_MASK (0x10U)
363 #define SDM_CH_SDCTRLP_WTSYNMCLR_SHIFT (4U)
364 #define SDM_CH_SDCTRLP_WTSYNMCLR_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_WTSYNMCLR_SHIFT) & SDM_CH_SDCTRLP_WTSYNMCLR_MASK)
365 #define SDM_CH_SDCTRLP_WTSYNMCLR_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_WTSYNMCLR_MASK) >> SDM_CH_SDCTRLP_WTSYNMCLR_SHIFT)
366 
367 /*
368  * WTSYNCEN (RW)
369  *
370  * 1: Start to store data only after PWM SYNC event
371  * 0: Start to store data whenever enabled
372  */
373 #define SDM_CH_SDCTRLP_WTSYNCEN_MASK (0x8U)
374 #define SDM_CH_SDCTRLP_WTSYNCEN_SHIFT (3U)
375 #define SDM_CH_SDCTRLP_WTSYNCEN_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_WTSYNCEN_SHIFT) & SDM_CH_SDCTRLP_WTSYNCEN_MASK)
376 #define SDM_CH_SDCTRLP_WTSYNCEN_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_WTSYNCEN_MASK) >> SDM_CH_SDCTRLP_WTSYNCEN_SHIFT)
377 
378 /*
379  * D32 (RW)
380  *
381  * 1:32 bit data
382  * 0:16 bit data
383  */
384 #define SDM_CH_SDCTRLP_D32_MASK (0x4U)
385 #define SDM_CH_SDCTRLP_D32_SHIFT (2U)
386 #define SDM_CH_SDCTRLP_D32_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_D32_SHIFT) & SDM_CH_SDCTRLP_D32_MASK)
387 #define SDM_CH_SDCTRLP_D32_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_D32_MASK) >> SDM_CH_SDCTRLP_D32_SHIFT)
388 
389 /*
390  * DR_OPT (RW)
391  *
392  * 1: Use Data FIFO Ready as data ready when fifo fillings are greater than the threshold
393  * 0: Use Data Reg Ready as data ready
394  */
395 #define SDM_CH_SDCTRLP_DR_OPT_MASK (0x2U)
396 #define SDM_CH_SDCTRLP_DR_OPT_SHIFT (1U)
397 #define SDM_CH_SDCTRLP_DR_OPT_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_DR_OPT_SHIFT) & SDM_CH_SDCTRLP_DR_OPT_MASK)
398 #define SDM_CH_SDCTRLP_DR_OPT_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_DR_OPT_MASK) >> SDM_CH_SDCTRLP_DR_OPT_SHIFT)
399 
400 /*
401  * EN (RW)
402  *
403  * Data Path Enable
404  */
405 #define SDM_CH_SDCTRLP_EN_MASK (0x1U)
406 #define SDM_CH_SDCTRLP_EN_SHIFT (0U)
407 #define SDM_CH_SDCTRLP_EN_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLP_EN_SHIFT) & SDM_CH_SDCTRLP_EN_MASK)
408 #define SDM_CH_SDCTRLP_EN_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLP_EN_MASK) >> SDM_CH_SDCTRLP_EN_SHIFT)
409 
410 /* Bitfield definition for register of struct array CH: SDCTRLE */
411 /*
412  * SGD_ORDR (RW)
413  *
414  * CIC order
415  * 0: SYNC1
416  * 1: SYNC2
417  * 2: SYNC3
418  * 3: FAST_SYNC
419  */
420 #define SDM_CH_SDCTRLE_SGD_ORDR_MASK (0x60000UL)
421 #define SDM_CH_SDCTRLE_SGD_ORDR_SHIFT (17U)
422 #define SDM_CH_SDCTRLE_SGD_ORDR_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLE_SGD_ORDR_SHIFT) & SDM_CH_SDCTRLE_SGD_ORDR_MASK)
423 #define SDM_CH_SDCTRLE_SGD_ORDR_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLE_SGD_ORDR_MASK) >> SDM_CH_SDCTRLE_SGD_ORDR_SHIFT)
424 
425 /*
426  * PWMSYNC (RW)
427  *
428  * Asserted to double sync the PWM trigger signal
429  */
430 #define SDM_CH_SDCTRLE_PWMSYNC_MASK (0x10000UL)
431 #define SDM_CH_SDCTRLE_PWMSYNC_SHIFT (16U)
432 #define SDM_CH_SDCTRLE_PWMSYNC_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLE_PWMSYNC_SHIFT) & SDM_CH_SDCTRLE_PWMSYNC_MASK)
433 #define SDM_CH_SDCTRLE_PWMSYNC_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLE_PWMSYNC_MASK) >> SDM_CH_SDCTRLE_PWMSYNC_SHIFT)
434 
435 /*
436  * CIC_SCL (RW)
437  *
438  * CIC shift control
439  */
440 #define SDM_CH_SDCTRLE_CIC_SCL_MASK (0x7800U)
441 #define SDM_CH_SDCTRLE_CIC_SCL_SHIFT (11U)
442 #define SDM_CH_SDCTRLE_CIC_SCL_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLE_CIC_SCL_SHIFT) & SDM_CH_SDCTRLE_CIC_SCL_MASK)
443 #define SDM_CH_SDCTRLE_CIC_SCL_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLE_CIC_SCL_MASK) >> SDM_CH_SDCTRLE_CIC_SCL_SHIFT)
444 
445 /*
446  * CIC_DEC_RATIO (RW)
447  *
448  * CIC decimation ratio. 0 means div-by-256
449  */
450 #define SDM_CH_SDCTRLE_CIC_DEC_RATIO_MASK (0x7F8U)
451 #define SDM_CH_SDCTRLE_CIC_DEC_RATIO_SHIFT (3U)
452 #define SDM_CH_SDCTRLE_CIC_DEC_RATIO_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLE_CIC_DEC_RATIO_SHIFT) & SDM_CH_SDCTRLE_CIC_DEC_RATIO_MASK)
453 #define SDM_CH_SDCTRLE_CIC_DEC_RATIO_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLE_CIC_DEC_RATIO_MASK) >> SDM_CH_SDCTRLE_CIC_DEC_RATIO_SHIFT)
454 
455 /*
456  * IGN_INI_SAMPLES (RW)
457  *
458  * NotZero: Don't store the first samples that are not accurate
459  * Zero: Store all samples
460  */
461 #define SDM_CH_SDCTRLE_IGN_INI_SAMPLES_MASK (0x7U)
462 #define SDM_CH_SDCTRLE_IGN_INI_SAMPLES_SHIFT (0U)
463 #define SDM_CH_SDCTRLE_IGN_INI_SAMPLES_SET(x) (((uint32_t)(x) << SDM_CH_SDCTRLE_IGN_INI_SAMPLES_SHIFT) & SDM_CH_SDCTRLE_IGN_INI_SAMPLES_MASK)
464 #define SDM_CH_SDCTRLE_IGN_INI_SAMPLES_GET(x) (((uint32_t)(x) & SDM_CH_SDCTRLE_IGN_INI_SAMPLES_MASK) >> SDM_CH_SDCTRLE_IGN_INI_SAMPLES_SHIFT)
465 
466 /* Bitfield definition for register of struct array CH: SDST */
467 /*
468  * PERIOD_MCLK (RO)
469  *
470  * maxim of mclk spacing in cycles, using edges of mclk signal. In manchester coding mode, it is just the period of MCLK. In other modes, it is almost the half period.
471  */
472 #define SDM_CH_SDST_PERIOD_MCLK_MASK (0x7F800000UL)
473 #define SDM_CH_SDST_PERIOD_MCLK_SHIFT (23U)
474 #define SDM_CH_SDST_PERIOD_MCLK_GET(x) (((uint32_t)(x) & SDM_CH_SDST_PERIOD_MCLK_MASK) >> SDM_CH_SDST_PERIOD_MCLK_SHIFT)
475 
476 /*
477  * FIFO_DR (W1C)
478  *
479  * FIFO data ready
480  */
481 #define SDM_CH_SDST_FIFO_DR_MASK (0x200U)
482 #define SDM_CH_SDST_FIFO_DR_SHIFT (9U)
483 #define SDM_CH_SDST_FIFO_DR_SET(x) (((uint32_t)(x) << SDM_CH_SDST_FIFO_DR_SHIFT) & SDM_CH_SDST_FIFO_DR_MASK)
484 #define SDM_CH_SDST_FIFO_DR_GET(x) (((uint32_t)(x) & SDM_CH_SDST_FIFO_DR_MASK) >> SDM_CH_SDST_FIFO_DR_SHIFT)
485 
486 /*
487  * DOV_ERR (W1C)
488  *
489  * Data FIFO Overflow Error. Error flag.
490  */
491 #define SDM_CH_SDST_DOV_ERR_MASK (0x80U)
492 #define SDM_CH_SDST_DOV_ERR_SHIFT (7U)
493 #define SDM_CH_SDST_DOV_ERR_SET(x) (((uint32_t)(x) << SDM_CH_SDST_DOV_ERR_SHIFT) & SDM_CH_SDST_DOV_ERR_MASK)
494 #define SDM_CH_SDST_DOV_ERR_GET(x) (((uint32_t)(x) & SDM_CH_SDST_DOV_ERR_MASK) >> SDM_CH_SDST_DOV_ERR_SHIFT)
495 
496 /*
497  * DSAT_ERR (W1C)
498  *
499  * CIC out Data saturation err. Error flag.
500  */
501 #define SDM_CH_SDST_DSAT_ERR_MASK (0x40U)
502 #define SDM_CH_SDST_DSAT_ERR_SHIFT (6U)
503 #define SDM_CH_SDST_DSAT_ERR_SET(x) (((uint32_t)(x) << SDM_CH_SDST_DSAT_ERR_SHIFT) & SDM_CH_SDST_DSAT_ERR_MASK)
504 #define SDM_CH_SDST_DSAT_ERR_GET(x) (((uint32_t)(x) & SDM_CH_SDST_DSAT_ERR_MASK) >> SDM_CH_SDST_DSAT_ERR_SHIFT)
505 
506 /*
507  * WTSYNFLG (RO)
508  *
509  * Wait-for-sync event found
510  */
511 #define SDM_CH_SDST_WTSYNFLG_MASK (0x20U)
512 #define SDM_CH_SDST_WTSYNFLG_SHIFT (5U)
513 #define SDM_CH_SDST_WTSYNFLG_GET(x) (((uint32_t)(x) & SDM_CH_SDST_WTSYNFLG_MASK) >> SDM_CH_SDST_WTSYNFLG_SHIFT)
514 
515 /*
516  * FILL (RO)
517  *
518  * Data FIFO Fillings
519  */
520 #define SDM_CH_SDST_FILL_MASK (0x1FU)
521 #define SDM_CH_SDST_FILL_SHIFT (0U)
522 #define SDM_CH_SDST_FILL_GET(x) (((uint32_t)(x) & SDM_CH_SDST_FILL_MASK) >> SDM_CH_SDST_FILL_SHIFT)
523 
524 /* Bitfield definition for register of struct array CH: SDATA */
525 /*
526  * VAL (RO)
527  *
528  * Data
529  */
530 #define SDM_CH_SDATA_VAL_MASK (0xFFFFFFFFUL)
531 #define SDM_CH_SDATA_VAL_SHIFT (0U)
532 #define SDM_CH_SDATA_VAL_GET(x) (((uint32_t)(x) & SDM_CH_SDATA_VAL_MASK) >> SDM_CH_SDATA_VAL_SHIFT)
533 
534 /* Bitfield definition for register of struct array CH: SDFIFO */
535 /*
536  * VAL (RO)
537  *
538  * FIFO Data
539  */
540 #define SDM_CH_SDFIFO_VAL_MASK (0xFFFFFFFFUL)
541 #define SDM_CH_SDFIFO_VAL_SHIFT (0U)
542 #define SDM_CH_SDFIFO_VAL_GET(x) (((uint32_t)(x) & SDM_CH_SDFIFO_VAL_MASK) >> SDM_CH_SDFIFO_VAL_SHIFT)
543 
544 /* Bitfield definition for register of struct array CH: SCAMP */
545 /*
546  * VAL (RO)
547  *
548  * instant Amplitude Results
549  */
550 #define SDM_CH_SCAMP_VAL_MASK (0xFFFFU)
551 #define SDM_CH_SCAMP_VAL_SHIFT (0U)
552 #define SDM_CH_SCAMP_VAL_GET(x) (((uint32_t)(x) & SDM_CH_SCAMP_VAL_MASK) >> SDM_CH_SCAMP_VAL_SHIFT)
553 
554 /* Bitfield definition for register of struct array CH: SCHTL */
555 /*
556  * VAL (RW)
557  *
558  * Amplitude Threshold for High Limit
559  */
560 #define SDM_CH_SCHTL_VAL_MASK (0xFFFFU)
561 #define SDM_CH_SCHTL_VAL_SHIFT (0U)
562 #define SDM_CH_SCHTL_VAL_SET(x) (((uint32_t)(x) << SDM_CH_SCHTL_VAL_SHIFT) & SDM_CH_SCHTL_VAL_MASK)
563 #define SDM_CH_SCHTL_VAL_GET(x) (((uint32_t)(x) & SDM_CH_SCHTL_VAL_MASK) >> SDM_CH_SCHTL_VAL_SHIFT)
564 
565 /* Bitfield definition for register of struct array CH: SCHTLZ */
566 /*
567  * VAL (RW)
568  *
569  * Amplitude Threshold for zero crossing
570  */
571 #define SDM_CH_SCHTLZ_VAL_MASK (0xFFFFU)
572 #define SDM_CH_SCHTLZ_VAL_SHIFT (0U)
573 #define SDM_CH_SCHTLZ_VAL_SET(x) (((uint32_t)(x) << SDM_CH_SCHTLZ_VAL_SHIFT) & SDM_CH_SCHTLZ_VAL_MASK)
574 #define SDM_CH_SCHTLZ_VAL_GET(x) (((uint32_t)(x) & SDM_CH_SCHTLZ_VAL_MASK) >> SDM_CH_SCHTLZ_VAL_SHIFT)
575 
576 /* Bitfield definition for register of struct array CH: SCLLT */
577 /*
578  * VAL (RW)
579  *
580  * Amplitude Threshold for low limit
581  */
582 #define SDM_CH_SCLLT_VAL_MASK (0xFFFFU)
583 #define SDM_CH_SCLLT_VAL_SHIFT (0U)
584 #define SDM_CH_SCLLT_VAL_SET(x) (((uint32_t)(x) << SDM_CH_SCLLT_VAL_SHIFT) & SDM_CH_SCLLT_VAL_MASK)
585 #define SDM_CH_SCLLT_VAL_GET(x) (((uint32_t)(x) & SDM_CH_SCLLT_VAL_MASK) >> SDM_CH_SCLLT_VAL_SHIFT)
586 
587 /* Bitfield definition for register of struct array CH: SCCTRL */
588 /*
589  * HZ_EN (RW)
590  *
591  * Zero Crossing Enable
592  */
593 #define SDM_CH_SCCTRL_HZ_EN_MASK (0x800000UL)
594 #define SDM_CH_SCCTRL_HZ_EN_SHIFT (23U)
595 #define SDM_CH_SCCTRL_HZ_EN_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_HZ_EN_SHIFT) & SDM_CH_SCCTRL_HZ_EN_MASK)
596 #define SDM_CH_SCCTRL_HZ_EN_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_HZ_EN_MASK) >> SDM_CH_SCCTRL_HZ_EN_SHIFT)
597 
598 /*
599  * MF_IE (RW)
600  *
601  * Module failure Interrupt enable
602  */
603 #define SDM_CH_SCCTRL_MF_IE_MASK (0x400000UL)
604 #define SDM_CH_SCCTRL_MF_IE_SHIFT (22U)
605 #define SDM_CH_SCCTRL_MF_IE_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_MF_IE_SHIFT) & SDM_CH_SCCTRL_MF_IE_MASK)
606 #define SDM_CH_SCCTRL_MF_IE_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_MF_IE_MASK) >> SDM_CH_SCCTRL_MF_IE_SHIFT)
607 
608 /*
609  * HL_IE (RW)
610  *
611  * HLT Interrupt Enable
612  */
613 #define SDM_CH_SCCTRL_HL_IE_MASK (0x200000UL)
614 #define SDM_CH_SCCTRL_HL_IE_SHIFT (21U)
615 #define SDM_CH_SCCTRL_HL_IE_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_HL_IE_SHIFT) & SDM_CH_SCCTRL_HL_IE_MASK)
616 #define SDM_CH_SCCTRL_HL_IE_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_HL_IE_MASK) >> SDM_CH_SCCTRL_HL_IE_SHIFT)
617 
618 /*
619  * LL_IE (RW)
620  *
621  * LLT interrupt Enable
622  */
623 #define SDM_CH_SCCTRL_LL_IE_MASK (0x100000UL)
624 #define SDM_CH_SCCTRL_LL_IE_SHIFT (20U)
625 #define SDM_CH_SCCTRL_LL_IE_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_LL_IE_SHIFT) & SDM_CH_SCCTRL_LL_IE_MASK)
626 #define SDM_CH_SCCTRL_LL_IE_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_LL_IE_MASK) >> SDM_CH_SCCTRL_LL_IE_SHIFT)
627 
628 /*
629  * SGD_ORDR (RW)
630  *
631  * CIC order
632  * 0: SYNC1
633  * 1: SYNC2
634  * 2: SYNC3
635  * 3: FAST_SYNC
636  */
637 #define SDM_CH_SCCTRL_SGD_ORDR_MASK (0xC0000UL)
638 #define SDM_CH_SCCTRL_SGD_ORDR_SHIFT (18U)
639 #define SDM_CH_SCCTRL_SGD_ORDR_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_SGD_ORDR_SHIFT) & SDM_CH_SCCTRL_SGD_ORDR_MASK)
640 #define SDM_CH_SCCTRL_SGD_ORDR_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_SGD_ORDR_MASK) >> SDM_CH_SCCTRL_SGD_ORDR_SHIFT)
641 
642 /*
643  * CIC_DEC_RATIO (RW)
644  *
645  * CIC decimation ratio. 0 means div-by-32
646  */
647 #define SDM_CH_SCCTRL_CIC_DEC_RATIO_MASK (0x1F0U)
648 #define SDM_CH_SCCTRL_CIC_DEC_RATIO_SHIFT (4U)
649 #define SDM_CH_SCCTRL_CIC_DEC_RATIO_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_CIC_DEC_RATIO_SHIFT) & SDM_CH_SCCTRL_CIC_DEC_RATIO_MASK)
650 #define SDM_CH_SCCTRL_CIC_DEC_RATIO_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_CIC_DEC_RATIO_MASK) >> SDM_CH_SCCTRL_CIC_DEC_RATIO_SHIFT)
651 
652 /*
653  * IGN_INI_SAMPLES (RW)
654  *
655  * NotZero: Ignore the first samples that are not accurate
656  * Zero: Use all samples
657  */
658 #define SDM_CH_SCCTRL_IGN_INI_SAMPLES_MASK (0xEU)
659 #define SDM_CH_SCCTRL_IGN_INI_SAMPLES_SHIFT (1U)
660 #define SDM_CH_SCCTRL_IGN_INI_SAMPLES_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_IGN_INI_SAMPLES_SHIFT) & SDM_CH_SCCTRL_IGN_INI_SAMPLES_MASK)
661 #define SDM_CH_SCCTRL_IGN_INI_SAMPLES_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_IGN_INI_SAMPLES_MASK) >> SDM_CH_SCCTRL_IGN_INI_SAMPLES_SHIFT)
662 
663 /*
664  * EN (RW)
665  *
666  * Amplitude Path Enable
667  */
668 #define SDM_CH_SCCTRL_EN_MASK (0x1U)
669 #define SDM_CH_SCCTRL_EN_SHIFT (0U)
670 #define SDM_CH_SCCTRL_EN_SET(x) (((uint32_t)(x) << SDM_CH_SCCTRL_EN_SHIFT) & SDM_CH_SCCTRL_EN_MASK)
671 #define SDM_CH_SCCTRL_EN_GET(x) (((uint32_t)(x) & SDM_CH_SCCTRL_EN_MASK) >> SDM_CH_SCCTRL_EN_SHIFT)
672 
673 /* Bitfield definition for register of struct array CH: SCST */
674 /*
675  * HZ (W1C)
676  *
677  * Amplitude rising above HZ event found.
678  */
679 #define SDM_CH_SCST_HZ_MASK (0x8U)
680 #define SDM_CH_SCST_HZ_SHIFT (3U)
681 #define SDM_CH_SCST_HZ_SET(x) (((uint32_t)(x) << SDM_CH_SCST_HZ_SHIFT) & SDM_CH_SCST_HZ_MASK)
682 #define SDM_CH_SCST_HZ_GET(x) (((uint32_t)(x) & SDM_CH_SCST_HZ_MASK) >> SDM_CH_SCST_HZ_SHIFT)
683 
684 /*
685  * MF (W1C)
686  *
687  * power modulator Failure found. MCLK not found. Error flag.
688  */
689 #define SDM_CH_SCST_MF_MASK (0x4U)
690 #define SDM_CH_SCST_MF_SHIFT (2U)
691 #define SDM_CH_SCST_MF_SET(x) (((uint32_t)(x) << SDM_CH_SCST_MF_SHIFT) & SDM_CH_SCST_MF_MASK)
692 #define SDM_CH_SCST_MF_GET(x) (((uint32_t)(x) & SDM_CH_SCST_MF_MASK) >> SDM_CH_SCST_MF_SHIFT)
693 
694 /*
695  * CMPH (W1C)
696  *
697  * HLT out of range. Error flag.
698  */
699 #define SDM_CH_SCST_CMPH_MASK (0x2U)
700 #define SDM_CH_SCST_CMPH_SHIFT (1U)
701 #define SDM_CH_SCST_CMPH_SET(x) (((uint32_t)(x) << SDM_CH_SCST_CMPH_SHIFT) & SDM_CH_SCST_CMPH_MASK)
702 #define SDM_CH_SCST_CMPH_GET(x) (((uint32_t)(x) & SDM_CH_SCST_CMPH_MASK) >> SDM_CH_SCST_CMPH_SHIFT)
703 
704 /*
705  * CMPL (W1C)
706  *
707  * LLT out of range. Error flag.
708  */
709 #define SDM_CH_SCST_CMPL_MASK (0x1U)
710 #define SDM_CH_SCST_CMPL_SHIFT (0U)
711 #define SDM_CH_SCST_CMPL_SET(x) (((uint32_t)(x) << SDM_CH_SCST_CMPL_SHIFT) & SDM_CH_SCST_CMPL_MASK)
712 #define SDM_CH_SCST_CMPL_GET(x) (((uint32_t)(x) & SDM_CH_SCST_CMPL_MASK) >> SDM_CH_SCST_CMPL_SHIFT)
713 
714 
715 
716 /* CH register group index macro definition */
717 #define SDM_CH_0 (0UL)
718 #define SDM_CH_1 (1UL)
719 #define SDM_CH_2 (2UL)
720 #define SDM_CH_3 (3UL)
721 
722 
723 #endif /* HPM_SDM_H */
Definition: hpm_sdm_regs.h:12