imxrt-ral 0.6.2

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
#[doc = "KEYMGR"]
#[repr(C)]
pub struct RegisterBlock {
    #[doc = "CSR Master Key Control Register"]
    pub MASTER_KEY_CTRL: crate::RWRegister<u32>,
    _reserved0: [u8; 0x0c],
    #[doc = "CSR OTFAD-1 Key Control"]
    pub OTFAD1_KEY_CTRL: crate::RWRegister<u32>,
    _reserved1: [u8; 0x04],
    #[doc = "CSR OTFAD-2 Key Control"]
    pub OTFAD2_KEY_CTRL: crate::RWRegister<u32>,
    _reserved2: [u8; 0x04],
    #[doc = "CSR IEE Key Control"]
    pub IEE_KEY_CTRL: crate::RWRegister<u32>,
    _reserved3: [u8; 0x0c],
    #[doc = "CSR PUF Key Control"]
    pub PUF_KEY_CTRL: crate::RWRegister<u32>,
    _reserved4: [u8; 0x03cc],
    #[doc = "Slot 0 Control"]
    pub SLOT0_CTRL: crate::RWRegister<u32>,
    #[doc = "Slot1 Control"]
    pub SLOT1_CTRL: crate::RWRegister<u32>,
    #[doc = "Slot2 Control"]
    pub SLOT2_CTRL: crate::RWRegister<u32>,
    #[doc = "Slot3 Control"]
    pub SLOT3_CTRL: crate::RWRegister<u32>,
    #[doc = "Slot 4 Control"]
    pub SLOT4_CTRL: crate::RWRegister<u32>,
}
#[doc = "CSR Master Key Control Register"]
pub mod MASTER_KEY_CTRL {
    #[doc = "Key select for SNVS OTPMK. Default value comes from FUSE_MASTER_KEY_SEL."]
    pub mod SELECT {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "select key from UDF"]
            pub const SELECT_FROM_UDF: u32 = 0;
            #[doc = "If LOCK = 1, select key from PUF, otherwise select key from fuse (bypass the fuse OTPMK to SNVS)"]
            pub const SELECT_FROM_PUF: u32 = 0x01;
        }
    }
    #[doc = "lock this register, prevent from writing. Default value comes from FUSE_MASTER_KEY_SEL_LOCK."]
    pub mod LOCK {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "CSR OTFAD-1 Key Control"]
pub mod OTFAD1_KEY_CTRL {
    #[doc = "key select for OTFAD-1. Default value comes from FUSE_OTFAD1_KEY_SEL."]
    pub mod SELECT {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Select key from OCOTP USER_KEY5"]
            pub const SELECT_FROM_USER_KEY5: u32 = 0;
            #[doc = "If PUF_KEY_CTRL\\[LOCK\\] is 1, select key from PUF, otherwise select key from OCOTP USER_KEY5"]
            pub const SELECT_FROM_PUF: u32 = 0x01;
        }
    }
    #[doc = "lock this register, prevent from writing. Default value comes from FUSE_OTFAD1_KEY_SEL_LOCK."]
    pub mod LOCK {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "CSR OTFAD-2 Key Control"]
pub mod OTFAD2_KEY_CTRL {
    #[doc = "key select for OTFAD-2. Default value comes from FUSE_OTFAD1_KEY_SEL."]
    pub mod SELECT {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "select key from OCOTP USER_KEY5"]
            pub const SELECT_FROM_USER_KEY5: u32 = 0;
            #[doc = "If PUF_KEY_CTRL\\[LOCK\\] is 1, select key from PUF, otherwise select key from OCOTP USER_KEY5"]
            pub const SELECT_FROM_PUF: u32 = 0x01;
        }
    }
    #[doc = "lock this register, prevent from writing. Default value comes from FUSE_OTFAD2_KEY_SEL_LOCK."]
    pub mod LOCK {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "CSR IEE Key Control"]
pub mod IEE_KEY_CTRL {
    #[doc = "Restart load key signal for IEE"]
    pub mod RELOAD {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do nothing"]
            pub const IDLE: u32 = 0;
            #[doc = "Restart IEE key load flow"]
            pub const RESTART: u32 = 0x01;
        }
    }
}
#[doc = "CSR PUF Key Control"]
pub mod PUF_KEY_CTRL {
    #[doc = "Lock signal for key select"]
    pub mod LOCK {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not lock the key select"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Lock the key select to select key from PUF, otherwise bypass key from OCOPT and do not lock. Once it has been set to 1, it cannot be reset manually. It will be set to 0 when the IEE key reload operation is done."]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "Slot 0 Control"]
pub mod SLOT0_CTRL {
    #[doc = "Whitelist"]
    pub mod WHITE_LIST {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x0f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Lock whitelist"]
    pub mod LOCK_LIST {
        pub const offset: u32 = 15;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Whitelist is not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Whitelist is locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
    #[doc = "Allow non-secure write access to this register and the slot it controls"]
    pub mod TZ_NS {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow non-secure write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow non-secure write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Allow user write access to this register and the slot it controls"]
    pub mod TZ_USER {
        pub const offset: u32 = 17;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow user write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow user write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Lock control of this slot"]
    pub mod LOCK_CONTROL {
        pub const offset: u32 = 31;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not lock the control register of this slot"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Lock the control register of this slot"]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "Slot1 Control"]
pub mod SLOT1_CTRL {
    #[doc = "Whitelist"]
    pub mod WHITE_LIST {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x0f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Lock whitelist"]
    pub mod LOCK_LIST {
        pub const offset: u32 = 15;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Whitelist is not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Whitelist is locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
    #[doc = "Allow non-secure write access to this register and the slot it controls"]
    pub mod TZ_NS {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow non-secure write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow non-secure write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Allow user write access to this register and the slot it controls"]
    pub mod TZ_USER {
        pub const offset: u32 = 17;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow user write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow user write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Lock control of this slot"]
    pub mod LOCK_CONTROL {
        pub const offset: u32 = 31;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not lock the control register of this slot"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Lock the control register of this slot"]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "Slot2 Control"]
pub mod SLOT2_CTRL {
    #[doc = "Whitelist"]
    pub mod WHITE_LIST {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x0f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Lock whitelist"]
    pub mod LOCK_LIST {
        pub const offset: u32 = 15;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Whitelist is not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Whitelist is locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
    #[doc = "Allow non-secure write access to this register and the slot it controls"]
    pub mod TZ_NS {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow non-secure write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow non-secure write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Allow user write access to this register and the slot it controls"]
    pub mod TZ_USER {
        pub const offset: u32 = 17;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow user write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow user write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Lock control of this slot"]
    pub mod LOCK_CONTROL {
        pub const offset: u32 = 31;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not lock the control register of this slot"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Lock the control register of this slot"]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "Slot3 Control"]
pub mod SLOT3_CTRL {
    #[doc = "Whitelist"]
    pub mod WHITE_LIST {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x0f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Lock whitelist"]
    pub mod LOCK_LIST {
        pub const offset: u32 = 15;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Whitelist is not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Whitelist is locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
    #[doc = "Allow non-secure write access to this register and the slot it controls"]
    pub mod TZ_NS {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow non-secure write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow non-secure write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Allow user write access to this register and the slot it controls"]
    pub mod TZ_USER {
        pub const offset: u32 = 17;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow user write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow user write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Lock control of this slot"]
    pub mod LOCK_CONTROL {
        pub const offset: u32 = 31;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not lock the control register of this slot"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Lock the control register of this slot"]
            pub const LOCK: u32 = 0x01;
        }
    }
}
#[doc = "Slot 4 Control"]
pub mod SLOT4_CTRL {
    #[doc = "Whitelist"]
    pub mod WHITE_LIST {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x0f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Lock whitelist"]
    pub mod LOCK_LIST {
        pub const offset: u32 = 15;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Whitelist is not locked"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Whitelist is locked"]
            pub const LOCK: u32 = 0x01;
        }
    }
    #[doc = "Allow non-secure write access to this register and the slot it controls"]
    pub mod TZ_NS {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow non-secure write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow non-secure write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Allow user write access to this register and the slot it controls"]
    pub mod TZ_USER {
        pub const offset: u32 = 17;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not allow user write access"]
            pub const PREVENT: u32 = 0;
            #[doc = "Allow user write access"]
            pub const ALLOW: u32 = 0x01;
        }
    }
    #[doc = "Lock control of this slot"]
    pub mod LOCK_CONTROL {
        pub const offset: u32 = 31;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Do not lock the control register of this slot"]
            pub const UNLOCK: u32 = 0;
            #[doc = "Lock the control register of this slot"]
            pub const LOCK: u32 = 0x01;
        }
    }
}