imxrt-ral 0.2.1-alpha

Register access layer for all NXP i.MX RT microcontrollers
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
#![allow(non_snake_case, non_upper_case_globals)]
#![allow(non_camel_case_types)]
//! SRC
//!
//! Used by: imxrt1051, imxrt1052

use crate::{RORegister, RWRegister};
#[cfg(not(feature = "nosync"))]
use core::marker::PhantomData;

/// SRC Control Register
pub mod SCR {

    /// Mask wdog_rst_b source
    pub mod mask_wdog_rst {
        /// Offset (7 bits)
        pub const offset: u32 = 7;
        /// Mask (4 bits: 0b1111 << 7)
        pub const mask: u32 = 0b1111 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0101: wdog_rst_b is masked
            pub const mask_wdog_rst_5: u32 = 0b0101;

            /// 0b1010: wdog_rst_b is not masked (default)
            pub const mask_wdog_rst_10: u32 = 0b1010;
        }
    }

    /// Software reset for core0 only
    pub mod core0_rst {
        /// Offset (13 bits)
        pub const offset: u32 = 13;
        /// Mask (1 bit: 1 << 13)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: do not assert core0 reset
            pub const core0_rst_0: u32 = 0b0;

            /// 0b1: assert core0 reset
            pub const core0_rst_1: u32 = 0b1;
        }
    }

    /// Software reset for core0 debug only
    pub mod core0_dbg_rst {
        /// Offset (17 bits)
        pub const offset: u32 = 17;
        /// Mask (1 bit: 1 << 17)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: do not assert core0 debug reset
            pub const core0_dbg_rst_0: u32 = 0b0;

            /// 0b1: assert core0 debug reset
            pub const core0_dbg_rst_1: u32 = 0b1;
        }
    }

    /// Do not assert debug resets after power gating event of core
    pub mod dbg_rst_msk_pg {
        /// Offset (25 bits)
        pub const offset: u32 = 25;
        /// Mask (1 bit: 1 << 25)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: do not mask core debug resets (debug resets will be asserted after power gating event)
            pub const dbg_rst_msk_pg_0: u32 = 0b0;

            /// 0b1: mask core debug resets (debug resets won't be asserted after power gating event)
            pub const dbg_rst_msk_pg_1: u32 = 0b1;
        }
    }

    /// Mask wdog3_rst_b source
    pub mod mask_wdog3_rst {
        /// Offset (28 bits)
        pub const offset: u32 = 28;
        /// Mask (4 bits: 0b1111 << 28)
        pub const mask: u32 = 0b1111 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0101: wdog3_rst_b is masked
            pub const mask_wdog3_rst_5: u32 = 0b0101;

            /// 0b1010: wdog3_rst_b is not masked
            pub const mask_wdog3_rst_10: u32 = 0b1010;
        }
    }
}

/// SRC Boot Mode Register 1
pub mod SBMR1 {

    /// Refer to fusemap.
    pub mod BOOT_CFG1 {
        /// Offset (0 bits)
        pub const offset: u32 = 0;
        /// Mask (8 bits: 0xff << 0)
        pub const mask: u32 = 0xff << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }

    /// Refer to fusemap.
    pub mod BOOT_CFG2 {
        /// Offset (8 bits)
        pub const offset: u32 = 8;
        /// Mask (8 bits: 0xff << 8)
        pub const mask: u32 = 0xff << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }

    /// Refer to fusemap.
    pub mod BOOT_CFG3 {
        /// Offset (16 bits)
        pub const offset: u32 = 16;
        /// Mask (8 bits: 0xff << 16)
        pub const mask: u32 = 0xff << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }

    /// Refer to fusemap.
    pub mod BOOT_CFG4 {
        /// Offset (24 bits)
        pub const offset: u32 = 24;
        /// Mask (8 bits: 0xff << 24)
        pub const mask: u32 = 0xff << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }
}

/// SRC Reset Status Register
pub mod SRSR {

    /// Indicates whether reset was the result of ipp_reset_b pin (Power-up sequence)
    pub mod ipp_reset_b {
        /// Offset (0 bits)
        pub const offset: u32 = 0;
        /// Mask (1 bit: 1 << 0)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of ipp_reset_b pin.
            pub const ipp_reset_b_0: u32 = 0b0;

            /// 0b1: Reset is a result of ipp_reset_b pin.
            pub const ipp_reset_b_1: u32 = 0b1;
        }
    }

    /// Indicates a reset has been caused by CPU lockup or software setting of SYSRESETREQ bit in Application Interrupt and Reset Control Register of the ARM core
    pub mod lockup_sysresetreq {
        /// Offset (1 bits)
        pub const offset: u32 = 1;
        /// Mask (1 bit: 1 << 1)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of the mentioned case.
            pub const lockup_sysresetreq_0: u32 = 0b0;

            /// 0b1: Reset is a result of the mentioned case.
            pub const lockup_sysresetreq_1: u32 = 0b1;
        }
    }

    /// Indicates whether the reset was the result of the csu_reset_b input.
    pub mod csu_reset_b {
        /// Offset (2 bits)
        pub const offset: u32 = 2;
        /// Mask (1 bit: 1 << 2)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of the csu_reset_b event.
            pub const csu_reset_b_0: u32 = 0b0;

            /// 0b1: Reset is a result of the csu_reset_b event.
            pub const csu_reset_b_1: u32 = 0b1;
        }
    }

    /// Indicates whether the reset was the result of the ipp_user_reset_b qualified reset.
    pub mod ipp_user_reset_b {
        /// Offset (3 bits)
        pub const offset: u32 = 3;
        /// Mask (1 bit: 1 << 3)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of the ipp_user_reset_b qualified as COLD reset event.
            pub const ipp_user_reset_b_0: u32 = 0b0;

            /// 0b1: Reset is a result of the ipp_user_reset_b qualified as COLD reset event.
            pub const ipp_user_reset_b_1: u32 = 0b1;
        }
    }

    /// IC Watchdog Time-out reset
    pub mod wdog_rst_b {
        /// Offset (4 bits)
        pub const offset: u32 = 4;
        /// Mask (1 bit: 1 << 4)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of the watchdog time-out event.
            pub const wdog_rst_b_0: u32 = 0b0;

            /// 0b1: Reset is a result of the watchdog time-out event.
            pub const wdog_rst_b_1: u32 = 0b1;
        }
    }

    /// HIGH - Z JTAG reset. Indicates whether the reset was the result of HIGH-Z reset from JTAG.
    pub mod jtag_rst_b {
        /// Offset (5 bits)
        pub const offset: u32 = 5;
        /// Mask (1 bit: 1 << 5)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of HIGH-Z reset from JTAG.
            pub const jtag_rst_b_0: u32 = 0b0;

            /// 0b1: Reset is a result of HIGH-Z reset from JTAG.
            pub const jtag_rst_b_1: u32 = 0b1;
        }
    }

    /// JTAG software reset. Indicates whether the reset was the result of software reset from JTAG.
    pub mod jtag_sw_rst {
        /// Offset (6 bits)
        pub const offset: u32 = 6;
        /// Mask (1 bit: 1 << 6)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of software reset from JTAG.
            pub const jtag_sw_rst_0: u32 = 0b0;

            /// 0b1: Reset is a result of software reset from JTAG.
            pub const jtag_sw_rst_1: u32 = 0b1;
        }
    }

    /// IC Watchdog3 Time-out reset
    pub mod wdog3_rst_b {
        /// Offset (7 bits)
        pub const offset: u32 = 7;
        /// Mask (1 bit: 1 << 7)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of the watchdog3 time-out event.
            pub const wdog3_rst_b_0: u32 = 0b0;

            /// 0b1: Reset is a result of the watchdog3 time-out event.
            pub const wdog3_rst_b_1: u32 = 0b1;
        }
    }

    /// Temper Sensor software reset
    pub mod tempsense_rst_b {
        /// Offset (8 bits)
        pub const offset: u32 = 8;
        /// Mask (1 bit: 1 << 8)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values
        pub mod RW {

            /// 0b0: Reset is not a result of software reset from Temperature Sensor.
            pub const tempsense_rst_b_0: u32 = 0b0;

            /// 0b1: Reset is a result of software reset from Temperature Sensor.
            pub const tempsense_rst_b_1: u32 = 0b1;
        }
    }
}

/// SRC Boot Mode Register 2
pub mod SBMR2 {

    /// SECONFIG\[1\] shows the state of the SECONFIG\[1\] fuse
    pub mod SEC_CONFIG {
        /// Offset (0 bits)
        pub const offset: u32 = 0;
        /// Mask (2 bits: 0b11 << 0)
        pub const mask: u32 = 0b11 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }

    /// DIR_BT_DIS shows the state of the DIR_BT_DIS fuse
    pub mod DIR_BT_DIS {
        /// Offset (3 bits)
        pub const offset: u32 = 3;
        /// Mask (1 bit: 1 << 3)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }

    /// BT_FUSE_SEL (connected to gpio bt_fuse_sel) shows the state of the BT_FUSE_SEL fuse
    pub mod BT_FUSE_SEL {
        /// Offset (4 bits)
        pub const offset: u32 = 4;
        /// Mask (1 bit: 1 << 4)
        pub const mask: u32 = 1 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }

    /// BMOD\[1:0\] shows the latched state of the BOOT_MODE1 and BOOT_MODE0 signals on the rising edge of POR_B
    pub mod BMOD {
        /// Offset (24 bits)
        pub const offset: u32 = 24;
        /// Mask (2 bits: 0b11 << 24)
        pub const mask: u32 = 0b11 << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }
}

/// SRC General Purpose Register 1
pub mod GPR1 {

    /// Holds entry function for core0 for waking-up from low power mode
    pub mod PERSISTENT_ENTRY0 {
        /// Offset (0 bits)
        pub const offset: u32 = 0;
        /// Mask (32 bits: 0xffffffff << 0)
        pub const mask: u32 = 0xffffffff << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }
}

/// SRC General Purpose Register 2
pub mod GPR2 {

    /// Holds argument of entry function for core0 for waking-up from low power mode
    pub mod PERSISTENT_ARG0 {
        /// Offset (0 bits)
        pub const offset: u32 = 0;
        /// Mask (32 bits: 0xffffffff << 0)
        pub const mask: u32 = 0xffffffff << offset;
        /// Read-only values (empty)
        pub mod R {}
        /// Write-only values (empty)
        pub mod W {}
        /// Read-write values (empty)
        pub mod RW {}
    }
}

/// SRC General Purpose Register 3
pub mod GPR3 {}

/// SRC General Purpose Register 4
pub mod GPR4 {}

/// SRC General Purpose Register 5
pub mod GPR5 {}

/// SRC General Purpose Register 6
pub mod GPR6 {}

/// SRC General Purpose Register 7
pub mod GPR7 {}

/// SRC General Purpose Register 8
pub mod GPR8 {}

/// SRC General Purpose Register 9
pub mod GPR9 {}

/// SRC General Purpose Register 10
pub mod GPR10 {}
#[repr(C)]
pub struct RegisterBlock {
    /// SRC Control Register
    pub SCR: RWRegister<u32>,

    /// SRC Boot Mode Register 1
    pub SBMR1: RORegister<u32>,

    /// SRC Reset Status Register
    pub SRSR: RWRegister<u32>,

    _reserved1: [u32; 4],

    /// SRC Boot Mode Register 2
    pub SBMR2: RORegister<u32>,

    /// SRC General Purpose Register 1
    pub GPR1: RWRegister<u32>,

    /// SRC General Purpose Register 2
    pub GPR2: RWRegister<u32>,

    /// SRC General Purpose Register 3
    pub GPR3: RWRegister<u32>,

    /// SRC General Purpose Register 4
    pub GPR4: RWRegister<u32>,

    /// SRC General Purpose Register 5
    pub GPR5: RWRegister<u32>,

    /// SRC General Purpose Register 6
    pub GPR6: RWRegister<u32>,

    /// SRC General Purpose Register 7
    pub GPR7: RWRegister<u32>,

    /// SRC General Purpose Register 8
    pub GPR8: RWRegister<u32>,

    /// SRC General Purpose Register 9
    pub GPR9: RORegister<u32>,

    /// SRC General Purpose Register 10
    pub GPR10: RWRegister<u32>,
}
pub struct ResetValues {
    pub SCR: u32,
    pub SBMR1: u32,
    pub SRSR: u32,
    pub SBMR2: u32,
    pub GPR1: u32,
    pub GPR2: u32,
    pub GPR3: u32,
    pub GPR4: u32,
    pub GPR5: u32,
    pub GPR6: u32,
    pub GPR7: u32,
    pub GPR8: u32,
    pub GPR9: u32,
    pub GPR10: u32,
}
#[cfg(not(feature = "nosync"))]
pub struct Instance {
    pub(crate) addr: u32,
    pub(crate) _marker: PhantomData<*const RegisterBlock>,
}
#[cfg(not(feature = "nosync"))]
impl ::core::ops::Deref for Instance {
    type Target = RegisterBlock;
    #[inline(always)]
    fn deref(&self) -> &RegisterBlock {
        unsafe { &*(self.addr as *const _) }
    }
}
#[cfg(feature = "rtfm")]
unsafe impl Send for Instance {}