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
#[doc = "NETC EMDIO base function"]
#[repr(C)]
pub struct RegisterBlock {
    _reserved0: [u8; 0x1c00],
    #[doc = "External MDIO configuration register"]
    pub EMDIO_CFG: crate::RWRegister<u32>,
    #[doc = "External MDIO interface control register"]
    pub EMDIO_CTL: crate::RWRegister<u32>,
    #[doc = "External MDIO interface data register"]
    pub EMDIO_DATA: crate::RWRegister<u32>,
    #[doc = "External MDIO register address register"]
    pub EMDIO_ADDR: crate::RWRegister<u32>,
    #[doc = "External MDIO status register"]
    pub EMDIO_STAT: crate::RORegister<u32>,
    _reserved1: [u8; 0x0c],
    #[doc = "PHY status configuration register"]
    pub PHY_STATUS_CFG: crate::RWRegister<u32>,
    #[doc = "PHY status control register"]
    pub PHY_STATUS_CTL: crate::RWRegister<u32>,
    #[doc = "PHY status data register"]
    pub PHY_STATUS_DATA: crate::RORegister<u32>,
    #[doc = "PHY status register address register"]
    pub PHY_STATUS_ADDR: crate::RWRegister<u32>,
    #[doc = "PHY status event register"]
    pub PHY_STATUS_EVENT: crate::RWRegister<u32>,
    #[doc = "PHY status mask register"]
    pub PHY_STATUS_MASK: crate::RWRegister<u32>,
    _reserved2: [u8; 0x08],
    #[doc = "MDIO configuration register"]
    pub MDIO_CFG: crate::RORegister<u32>,
}
#[doc = "External MDIO configuration register"]
pub mod EMDIO_CFG {
    #[doc = "Busy 2 (same as bit 31)"]
    pub mod BSY2 {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "An MDIO transaction is not occurring; software may access other MDIO registers."]
            pub const ZERO: u32 = 0;
            #[doc = "An MDIO transaction is occurring."]
            pub const ONE: u32 = 0x01;
        }
    }
    #[doc = "MDIO Read Error"]
    pub mod MDIO_RD_ER {
        pub const offset: u32 = 1;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "No error"]
            pub const ZERO: u32 = 0;
            #[doc = "The last read transaction received no response from a PHY; any data read should be considered invalid (for example, the PHY address does not match any PHY available on the MDIO bus)."]
            pub const ONE: u32 = 0x01;
        }
    }
    #[doc = "MDIO Hold Time"]
    pub mod MDIO_HOLD {
        pub const offset: u32 = 2;
        pub const mask: u32 = 0x07 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "1 NETC cycle"]
            pub const NETC1: u32 = 0;
            #[doc = "3 NETC cycles"]
            pub const NETC3: u32 = 0x01;
            #[doc = "5 NETC cycles (default - recommended value)"]
            pub const NETC5: u32 = 0x02;
            #[doc = "7 NETC cycles"]
            pub const NETC7: u32 = 0x03;
            #[doc = "9 NETC cycles"]
            pub const NETC9: u32 = 0x04;
            #[doc = "11 NETC cycles"]
            pub const NETC11: u32 = 0x05;
            #[doc = "13 NETC cycles"]
            pub const NETC13: u32 = 0x06;
            #[doc = "15 NETC cycles"]
            pub const NETC15: u32 = 0x07;
        }
    }
    #[doc = "MDIO Preamble Disable"]
    pub mod PRE_DIS {
        pub const offset: u32 = 5;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Generation of MDIO preamble is enabled (default operation)."]
            pub const ZERO: u32 = 0;
            #[doc = "Generation of MDIO preamble is disabled"]
            pub const ONE: u32 = 0x01;
        }
    }
    #[doc = "Enable Clause 45 Support"]
    pub mod ENC45 {
        pub const offset: u32 = 6;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Clause 22 transactions are used."]
            pub const ZERO: u32 = 0;
            #[doc = "Clause 45 transactions are used."]
            pub const ONE: u32 = 0x01;
        }
    }
    #[doc = "MDIO Clock Divisor"]
    pub mod MDIO_CLK_DIV {
        pub const offset: u32 = 7;
        pub const mask: u32 = 0x01ff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Returns the virtual port ID."]
    pub mod WHOAMI {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x07 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Extended HOLD"]
    pub mod EHOLD {
        pub const offset: u32 = 22;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Normal operation. MDIO hold time is specified in ."]
            pub const ZERO: u32 = 0;
            #[doc = "Extended Operation"]
            pub const ONE: u32 = 0x01;
        }
    }
    #[doc = "Negative Edge"]
    pub mod NEG {
        pub const offset: u32 = 23;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Normal operation - positive edge"]
            pub const NORMAL: u32 = 0;
            #[doc = "MDIO is driven by master on MDC negative edge (default for external MDIOs)"]
            pub const NEGATIVE: u32 = 0x01;
        }
    }
    #[doc = "Address Error"]
    pub mod ADDR_ERR {
        pub const offset: u32 = 28;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Normal"]
            pub const NORMAL: u32 = 0;
            #[doc = "Error. An access control violation has occurred. The request address used does not match the MDIO PHY's address (clause 22) or MDIO port address (clause 45) assigned."]
            pub const ERROR: u32 = 0x01;
        }
    }
    #[doc = "MDIO Command Completion Interrupt Enable Mask"]
    pub mod CIM {
        pub const offset: u32 = 29;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "Masked"]
            pub const MASKED: u32 = 0;
            #[doc = "Enabled"]
            pub const ENABLED: u32 = 0x01;
        }
    }
    #[doc = "MDIO Command Completion"]
    pub mod CMP {
        pub const offset: u32 = 30;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "An MDIO command completion did not occur."]
            pub const ZERO: u32 = 0;
            #[doc = "An MDIO command completion occurred."]
            pub const ONE: u32 = 0x01;
        }
    }
    #[doc = "Busy 1"]
    pub mod BSY1 {
        pub const offset: u32 = 31;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {
            #[doc = "An MDIO transaction is not occurring; software may access other MDIO registers."]
            pub const ZERO: u32 = 0;
            #[doc = "An MDIO transaction is occurring."]
            pub const ONE: u32 = 0x01;
        }
    }
}
#[doc = "External MDIO interface control register"]
pub mod EMDIO_CTL {
    #[doc = "5-bit MDIO device address (Clause 45) / register address (Clause 22)"]
    pub mod DEV_ADDR {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x1f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "5-bit MDIO port address (Clause 45) / PHY address (Clause 22)"]
    pub mod PORT_ADDR {
        pub const offset: u32 = 5;
        pub const mask: u32 = 0x1f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "MDIO read with address post-increment initiation. Self-clearing once transaction is complete."]
    pub mod POST_INC {
        pub const offset: u32 = 14;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "MDIO read initiation."]
    pub mod READ {
        pub const offset: u32 = 15;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "MDIO busy"]
    pub mod BSY {
        pub const offset: u32 = 31;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "External MDIO interface data register"]
pub mod EMDIO_DATA {
    #[doc = "16-bit MDIO data."]
    pub mod MDIO_DATA {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "External MDIO register address register"]
pub mod EMDIO_ADDR {
    #[doc = "MDIO PHY register address."]
    pub mod REGADDR {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "External MDIO status register"]
pub mod EMDIO_STAT {
    #[doc = "Global MDIO busy"]
    pub mod BSY {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "PHY white list"]
    pub mod WHT_LIST {
        pub const offset: u32 = 8;
        pub const mask: u32 = 0x1f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "PHY white list enable"]
    pub mod WHT_LIST_ENA {
        pub const offset: u32 = 15;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Port ID"]
    pub mod PORT_ID {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0x07 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Port ID"]
    pub mod REQ_TYPE {
        pub const offset: u32 = 19;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "PHY status configuration register"]
pub mod PHY_STATUS_CFG {
    #[doc = "MDIO busy"]
    pub mod BSY {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "MDIO read error"]
    pub mod MDIO_RD_ER {
        pub const offset: u32 = 1;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "PHY status read interval"]
    pub mod STATUS_INTERVAL {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "PHY status control register"]
pub mod PHY_STATUS_CTL {
    #[doc = "5-bit MDIO device address (Clause 45) / register address (Clause 22)"]
    pub mod DEV_ADDR {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0x1f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "5-bit MDIO port address (Clause 45) / PHY address (Clause 22)"]
    pub mod PORT_ADDR {
        pub const offset: u32 = 5;
        pub const mask: u32 = 0x1f << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "PHY status data register"]
pub mod PHY_STATUS_DATA {
    #[doc = "16-bit MDIO data"]
    pub mod MDIO_DATA {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Current count"]
    pub mod CURR_CNT {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "PHY status register address register"]
pub mod PHY_STATUS_ADDR {
    #[doc = "MDIO PHY register address. Address of the register within the Clause 45 PHY device from which data is to be read."]
    pub mod REGADDR {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "PHY status event register"]
pub mod PHY_STATUS_EVENT {
    #[doc = "Status event high-to-low. Set to 1 if a 1->0 transition on a corresponding data bit has occurred. Write 1 to clear."]
    pub mod STATUS_EVENT_HL {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Status event low-to-high. Set to 1 if a 0->1 transition on a corresponding data bit has occurred. Write 1 to clear."]
    pub mod STATUS_EVENT_LH {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "PHY status mask register"]
pub mod PHY_STATUS_MASK {
    #[doc = "Status high-to-low mask. If set to 1, assert an interrupt if the corresponding event bit is set."]
    pub mod STATUS_MASK_HL {
        pub const offset: u32 = 0;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "Status mask low-to-high. If set to 1, assert an interrupt if the corresponding event bit is set."]
    pub mod STATUS_MASK_LH {
        pub const offset: u32 = 16;
        pub const mask: u32 = 0xffff << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}
#[doc = "MDIO configuration register"]
pub mod MDIO_CFG {
    #[doc = "MDIO pin mode"]
    pub mod MDIO_MODE {
        pub const offset: u32 = 4;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
    #[doc = "MDC pin mode"]
    pub mod MDC_MODE {
        pub const offset: u32 = 5;
        pub const mask: u32 = 0x01 << offset;
        pub mod R {}
        pub mod W {}
        pub mod RW {}
    }
}