mcxa-pac 0.2.0

Peripheral Access Crate for MCXA256 devices
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
#[doc = "Register `VERID` reader"]
pub type R = crate::R<VeridSpec>;
#[doc = "Resolution\n\nValue on reset: 1"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Res {
    #[doc = "0: Up to 12-bit single ended resolution supported (and 13-bit differential resolution if VERID\\[DIFFEN\\] = 1b)."]
    Max13Bit = 0,
    #[doc = "1: Up to 16-bit single ended resolution supported (and 16-bit differential resolution if VERID\\[DIFFEN\\] = 1b)."]
    Max16Bit = 1,
}
impl From<Res> for bool {
    #[inline(always)]
    fn from(variant: Res) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `RES` reader - Resolution"]
pub type ResR = crate::BitReader<Res>;
impl ResR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Res {
        match self.bits {
            false => Res::Max13Bit,
            true => Res::Max16Bit,
        }
    }
    #[doc = "Up to 12-bit single ended resolution supported (and 13-bit differential resolution if VERID\\[DIFFEN\\] = 1b)."]
    #[inline(always)]
    pub fn is_max_13_bit(&self) -> bool {
        *self == Res::Max13Bit
    }
    #[doc = "Up to 16-bit single ended resolution supported (and 16-bit differential resolution if VERID\\[DIFFEN\\] = 1b)."]
    #[inline(always)]
    pub fn is_max_16_bit(&self) -> bool {
        *self == Res::Max16Bit
    }
}
#[doc = "Differential Supported\n\nValue on reset: 0"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Diffen {
    #[doc = "0: Differential operation not supported."]
    DifferentialNotSupported = 0,
    #[doc = "1: Differential operation supported."]
    DifferentialSupported = 1,
}
impl From<Diffen> for bool {
    #[inline(always)]
    fn from(variant: Diffen) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `DIFFEN` reader - Differential Supported"]
pub type DiffenR = crate::BitReader<Diffen>;
impl DiffenR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Diffen {
        match self.bits {
            false => Diffen::DifferentialNotSupported,
            true => Diffen::DifferentialSupported,
        }
    }
    #[doc = "Differential operation not supported."]
    #[inline(always)]
    pub fn is_differential_not_supported(&self) -> bool {
        *self == Diffen::DifferentialNotSupported
    }
    #[doc = "Differential operation supported."]
    #[inline(always)]
    pub fn is_differential_supported(&self) -> bool {
        *self == Diffen::DifferentialSupported
    }
}
#[doc = "Multi Vref Implemented\n\nValue on reset: 1"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Mvi {
    #[doc = "0: Single voltage reference high (VREFH) input supported."]
    MultipleRefNotSupported = 0,
    #[doc = "1: Multiple voltage reference high (VREFH) inputs supported."]
    MultipleRefSupported = 1,
}
impl From<Mvi> for bool {
    #[inline(always)]
    fn from(variant: Mvi) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `MVI` reader - Multi Vref Implemented"]
pub type MviR = crate::BitReader<Mvi>;
impl MviR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Mvi {
        match self.bits {
            false => Mvi::MultipleRefNotSupported,
            true => Mvi::MultipleRefSupported,
        }
    }
    #[doc = "Single voltage reference high (VREFH) input supported."]
    #[inline(always)]
    pub fn is_multiple_ref_not_supported(&self) -> bool {
        *self == Mvi::MultipleRefNotSupported
    }
    #[doc = "Multiple voltage reference high (VREFH) inputs supported."]
    #[inline(always)]
    pub fn is_multiple_ref_supported(&self) -> bool {
        *self == Mvi::MultipleRefSupported
    }
}
#[doc = "Channel Scale Width\n\nValue on reset: 0"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum Csw {
    #[doc = "0: Channel scaling not supported."]
    CscaleNotSupported = 0,
    #[doc = "1: Channel scaling supported. 1-bit CSCALE control field."]
    BitWidth1 = 1,
    #[doc = "6: Channel scaling supported. 6-bit CSCALE control field."]
    BitWidth6 = 6,
}
impl From<Csw> for u8 {
    #[inline(always)]
    fn from(variant: Csw) -> Self {
        variant as _
    }
}
impl crate::FieldSpec for Csw {
    type Ux = u8;
}
impl crate::IsEnum for Csw {}
#[doc = "Field `CSW` reader - Channel Scale Width"]
pub type CswR = crate::FieldReader<Csw>;
impl CswR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Option<Csw> {
        match self.bits {
            0 => Some(Csw::CscaleNotSupported),
            1 => Some(Csw::BitWidth1),
            6 => Some(Csw::BitWidth6),
            _ => None,
        }
    }
    #[doc = "Channel scaling not supported."]
    #[inline(always)]
    pub fn is_cscale_not_supported(&self) -> bool {
        *self == Csw::CscaleNotSupported
    }
    #[doc = "Channel scaling supported. 1-bit CSCALE control field."]
    #[inline(always)]
    pub fn is_bit_width_1(&self) -> bool {
        *self == Csw::BitWidth1
    }
    #[doc = "Channel scaling supported. 6-bit CSCALE control field."]
    #[inline(always)]
    pub fn is_bit_width_6(&self) -> bool {
        *self == Csw::BitWidth6
    }
}
#[doc = "Voltage Reference 1 Range Control Bit Implemented\n\nValue on reset: 0"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Vr1rngi {
    #[doc = "0: Range control not required. CFG\\[VREF1RNG\\] is not implemented."]
    Ref1FixedVoltageRange = 0,
    #[doc = "1: Range control required. CFG\\[VREF1RNG\\] is implemented."]
    Ref1SelectableVoltageRange = 1,
}
impl From<Vr1rngi> for bool {
    #[inline(always)]
    fn from(variant: Vr1rngi) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `VR1RNGI` reader - Voltage Reference 1 Range Control Bit Implemented"]
pub type Vr1rngiR = crate::BitReader<Vr1rngi>;
impl Vr1rngiR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Vr1rngi {
        match self.bits {
            false => Vr1rngi::Ref1FixedVoltageRange,
            true => Vr1rngi::Ref1SelectableVoltageRange,
        }
    }
    #[doc = "Range control not required. CFG\\[VREF1RNG\\] is not implemented."]
    #[inline(always)]
    pub fn is_ref1_fixed_voltage_range(&self) -> bool {
        *self == Vr1rngi::Ref1FixedVoltageRange
    }
    #[doc = "Range control required. CFG\\[VREF1RNG\\] is implemented."]
    #[inline(always)]
    pub fn is_ref1_selectable_voltage_range(&self) -> bool {
        *self == Vr1rngi::Ref1SelectableVoltageRange
    }
}
#[doc = "Internal ADC Clock Implemented\n\nValue on reset: 0"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Iadcki {
    #[doc = "0: Internal clock source not implemented."]
    InternalClkNotAvailable = 0,
    #[doc = "1: Internal clock source (and CFG\\[ADCKEN\\]) implemented."]
    InternalClkAvailable = 1,
}
impl From<Iadcki> for bool {
    #[inline(always)]
    fn from(variant: Iadcki) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `IADCKI` reader - Internal ADC Clock Implemented"]
pub type IadckiR = crate::BitReader<Iadcki>;
impl IadckiR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Iadcki {
        match self.bits {
            false => Iadcki::InternalClkNotAvailable,
            true => Iadcki::InternalClkAvailable,
        }
    }
    #[doc = "Internal clock source not implemented."]
    #[inline(always)]
    pub fn is_internal_clk_not_available(&self) -> bool {
        *self == Iadcki::InternalClkNotAvailable
    }
    #[doc = "Internal clock source (and CFG\\[ADCKEN\\]) implemented."]
    #[inline(always)]
    pub fn is_internal_clk_available(&self) -> bool {
        *self == Iadcki::InternalClkAvailable
    }
}
#[doc = "Calibration Function Implemented\n\nValue on reset: 1"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Calofsi {
    #[doc = "0: Calibration Not Implemented."]
    CalFunctionNotAvailable = 0,
    #[doc = "1: Calibration Implemented."]
    CalFunctionAvailable = 1,
}
impl From<Calofsi> for bool {
    #[inline(always)]
    fn from(variant: Calofsi) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `CALOFSI` reader - Calibration Function Implemented"]
pub type CalofsiR = crate::BitReader<Calofsi>;
impl CalofsiR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Calofsi {
        match self.bits {
            false => Calofsi::CalFunctionNotAvailable,
            true => Calofsi::CalFunctionAvailable,
        }
    }
    #[doc = "Calibration Not Implemented."]
    #[inline(always)]
    pub fn is_cal_function_not_available(&self) -> bool {
        *self == Calofsi::CalFunctionNotAvailable
    }
    #[doc = "Calibration Implemented."]
    #[inline(always)]
    pub fn is_cal_function_available(&self) -> bool {
        *self == Calofsi::CalFunctionAvailable
    }
}
#[doc = "Number of Single Ended Outputs Supported\n\nValue on reset: 0"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum NumSec {
    #[doc = "0: This design supports one single ended conversion at a time."]
    SingleConvertor = 0,
    #[doc = "1: This design supports two simultaneous single ended conversions."]
    DualConvertor = 1,
}
impl From<NumSec> for bool {
    #[inline(always)]
    fn from(variant: NumSec) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `NUM_SEC` reader - Number of Single Ended Outputs Supported"]
pub type NumSecR = crate::BitReader<NumSec>;
impl NumSecR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> NumSec {
        match self.bits {
            false => NumSec::SingleConvertor,
            true => NumSec::DualConvertor,
        }
    }
    #[doc = "This design supports one single ended conversion at a time."]
    #[inline(always)]
    pub fn is_single_convertor(&self) -> bool {
        *self == NumSec::SingleConvertor
    }
    #[doc = "This design supports two simultaneous single ended conversions."]
    #[inline(always)]
    pub fn is_dual_convertor(&self) -> bool {
        *self == NumSec::DualConvertor
    }
}
#[doc = "Number of FIFOs\n\nValue on reset: 1"]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum NumFifo {
    #[doc = "0: N/A"]
    NoFifoImplemented = 0,
    #[doc = "1: This design supports one result FIFO."]
    Cnt1 = 1,
    #[doc = "2: This design supports two result FIFOs."]
    Cnt2 = 2,
    #[doc = "3: This design supports three result FIFOs."]
    Cnt3 = 3,
    #[doc = "4: This design supports four result FIFOs."]
    Cnt4 = 4,
}
impl From<NumFifo> for u8 {
    #[inline(always)]
    fn from(variant: NumFifo) -> Self {
        variant as _
    }
}
impl crate::FieldSpec for NumFifo {
    type Ux = u8;
}
impl crate::IsEnum for NumFifo {}
#[doc = "Field `NUM_FIFO` reader - Number of FIFOs"]
pub type NumFifoR = crate::FieldReader<NumFifo>;
impl NumFifoR {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub const fn variant(&self) -> Option<NumFifo> {
        match self.bits {
            0 => Some(NumFifo::NoFifoImplemented),
            1 => Some(NumFifo::Cnt1),
            2 => Some(NumFifo::Cnt2),
            3 => Some(NumFifo::Cnt3),
            4 => Some(NumFifo::Cnt4),
            _ => None,
        }
    }
    #[doc = "N/A"]
    #[inline(always)]
    pub fn is_no_fifo_implemented(&self) -> bool {
        *self == NumFifo::NoFifoImplemented
    }
    #[doc = "This design supports one result FIFO."]
    #[inline(always)]
    pub fn is_cnt_1(&self) -> bool {
        *self == NumFifo::Cnt1
    }
    #[doc = "This design supports two result FIFOs."]
    #[inline(always)]
    pub fn is_cnt_2(&self) -> bool {
        *self == NumFifo::Cnt2
    }
    #[doc = "This design supports three result FIFOs."]
    #[inline(always)]
    pub fn is_cnt_3(&self) -> bool {
        *self == NumFifo::Cnt3
    }
    #[doc = "This design supports four result FIFOs."]
    #[inline(always)]
    pub fn is_cnt_4(&self) -> bool {
        *self == NumFifo::Cnt4
    }
}
#[doc = "Field `MINOR` reader - Minor Version Number"]
pub type MinorR = crate::FieldReader;
#[doc = "Field `MAJOR` reader - Major Version Number"]
pub type MajorR = crate::FieldReader;
impl R {
    #[doc = "Bit 0 - Resolution"]
    #[inline(always)]
    pub fn res(&self) -> ResR {
        ResR::new((self.bits & 1) != 0)
    }
    #[doc = "Bit 1 - Differential Supported"]
    #[inline(always)]
    pub fn diffen(&self) -> DiffenR {
        DiffenR::new(((self.bits >> 1) & 1) != 0)
    }
    #[doc = "Bit 3 - Multi Vref Implemented"]
    #[inline(always)]
    pub fn mvi(&self) -> MviR {
        MviR::new(((self.bits >> 3) & 1) != 0)
    }
    #[doc = "Bits 4:6 - Channel Scale Width"]
    #[inline(always)]
    pub fn csw(&self) -> CswR {
        CswR::new(((self.bits >> 4) & 7) as u8)
    }
    #[doc = "Bit 8 - Voltage Reference 1 Range Control Bit Implemented"]
    #[inline(always)]
    pub fn vr1rngi(&self) -> Vr1rngiR {
        Vr1rngiR::new(((self.bits >> 8) & 1) != 0)
    }
    #[doc = "Bit 9 - Internal ADC Clock Implemented"]
    #[inline(always)]
    pub fn iadcki(&self) -> IadckiR {
        IadckiR::new(((self.bits >> 9) & 1) != 0)
    }
    #[doc = "Bit 10 - Calibration Function Implemented"]
    #[inline(always)]
    pub fn calofsi(&self) -> CalofsiR {
        CalofsiR::new(((self.bits >> 10) & 1) != 0)
    }
    #[doc = "Bit 11 - Number of Single Ended Outputs Supported"]
    #[inline(always)]
    pub fn num_sec(&self) -> NumSecR {
        NumSecR::new(((self.bits >> 11) & 1) != 0)
    }
    #[doc = "Bits 12:14 - Number of FIFOs"]
    #[inline(always)]
    pub fn num_fifo(&self) -> NumFifoR {
        NumFifoR::new(((self.bits >> 12) & 7) as u8)
    }
    #[doc = "Bits 16:23 - Minor Version Number"]
    #[inline(always)]
    pub fn minor(&self) -> MinorR {
        MinorR::new(((self.bits >> 16) & 0xff) as u8)
    }
    #[doc = "Bits 24:31 - Major Version Number"]
    #[inline(always)]
    pub fn major(&self) -> MajorR {
        MajorR::new(((self.bits >> 24) & 0xff) as u8)
    }
}
#[cfg(feature = "debug")]
impl core::fmt::Debug for R {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.debug_struct("VERID")
            .field("res", &self.res())
            .field("diffen", &self.diffen())
            .field("mvi", &self.mvi())
            .field("csw", &self.csw())
            .field("vr1rngi", &self.vr1rngi())
            .field("iadcki", &self.iadcki())
            .field("calofsi", &self.calofsi())
            .field("num_sec", &self.num_sec())
            .field("num_fifo", &self.num_fifo())
            .field("minor", &self.minor())
            .field("major", &self.major())
            .finish()
    }
}
#[doc = "Version ID Register\n\nYou can [`read`](crate::Reg::read) this register and get [`verid::R`](R). See [API](https://docs.rs/svd2rust/#read--modify--write-api)."]
pub struct VeridSpec;
impl crate::RegisterSpec for VeridSpec {
    type Ux = u32;
}
#[doc = "`read()` method returns [`verid::R`](R) reader structure"]
impl crate::Readable for VeridSpec {}
#[doc = "`reset()` method sets VERID to value 0x0200_1409"]
impl crate::Resettable for VeridSpec {
    const RESET_VALUE: u32 = 0x0200_1409;
}