lpc55-pac 0.5.0

Peripheral access API for NXP LPC55 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
#[doc = "Register `PSELID` reader"]
pub struct R(crate::R<PSELID_SPEC>);
impl core::ops::Deref for R {
    type Target = crate::R<PSELID_SPEC>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl From<crate::R<PSELID_SPEC>> for R {
    #[inline(always)]
    fn from(reader: crate::R<PSELID_SPEC>) -> Self {
        R(reader)
    }
}
#[doc = "Register `PSELID` writer"]
pub struct W(crate::W<PSELID_SPEC>);
impl core::ops::Deref for W {
    type Target = crate::W<PSELID_SPEC>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl core::ops::DerefMut for W {
    #[inline(always)]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}
impl From<crate::W<PSELID_SPEC>> for W {
    #[inline(always)]
    fn from(writer: crate::W<PSELID_SPEC>) -> Self {
        W(writer)
    }
}
#[doc = "Peripheral Select. This field is writable by software.\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(u8)]
pub enum PERSEL_A {
    #[doc = "0: No peripheral selected."]
    NO_PERIPH_SELECTED = 0,
    #[doc = "1: USART function selected."]
    USART = 1,
    #[doc = "2: SPI function selected."]
    SPI = 2,
    #[doc = "3: I2C function selected."]
    I2C = 3,
    #[doc = "4: I2S transmit function selected."]
    I2S_TRANSMIT = 4,
    #[doc = "5: I2S receive function selected."]
    I2S_RECEIVE = 5,
}
impl From<PERSEL_A> for u8 {
    #[inline(always)]
    fn from(variant: PERSEL_A) -> Self {
        variant as _
    }
}
#[doc = "Field `PERSEL` reader - Peripheral Select. This field is writable by software."]
pub struct PERSEL_R(crate::FieldReader<u8, PERSEL_A>);
impl PERSEL_R {
    #[inline(always)]
    pub(crate) fn new(bits: u8) -> Self {
        PERSEL_R(crate::FieldReader::new(bits))
    }
    #[doc = r"Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> Option<PERSEL_A> {
        match self.bits {
            0 => Some(PERSEL_A::NO_PERIPH_SELECTED),
            1 => Some(PERSEL_A::USART),
            2 => Some(PERSEL_A::SPI),
            3 => Some(PERSEL_A::I2C),
            4 => Some(PERSEL_A::I2S_TRANSMIT),
            5 => Some(PERSEL_A::I2S_RECEIVE),
            _ => None,
        }
    }
    #[doc = "Checks if the value of the field is `NO_PERIPH_SELECTED`"]
    #[inline(always)]
    pub fn is_no_periph_selected(&self) -> bool {
        **self == PERSEL_A::NO_PERIPH_SELECTED
    }
    #[doc = "Checks if the value of the field is `USART`"]
    #[inline(always)]
    pub fn is_usart(&self) -> bool {
        **self == PERSEL_A::USART
    }
    #[doc = "Checks if the value of the field is `SPI`"]
    #[inline(always)]
    pub fn is_spi(&self) -> bool {
        **self == PERSEL_A::SPI
    }
    #[doc = "Checks if the value of the field is `I2C`"]
    #[inline(always)]
    pub fn is_i2c(&self) -> bool {
        **self == PERSEL_A::I2C
    }
    #[doc = "Checks if the value of the field is `I2S_TRANSMIT`"]
    #[inline(always)]
    pub fn is_i2s_transmit(&self) -> bool {
        **self == PERSEL_A::I2S_TRANSMIT
    }
    #[doc = "Checks if the value of the field is `I2S_RECEIVE`"]
    #[inline(always)]
    pub fn is_i2s_receive(&self) -> bool {
        **self == PERSEL_A::I2S_RECEIVE
    }
}
impl core::ops::Deref for PERSEL_R {
    type Target = crate::FieldReader<u8, PERSEL_A>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
#[doc = "Field `PERSEL` writer - Peripheral Select. This field is writable by software."]
pub struct PERSEL_W<'a> {
    w: &'a mut W,
}
impl<'a> PERSEL_W<'a> {
    #[doc = r"Writes `variant` to the field"]
    #[inline(always)]
    pub fn variant(self, variant: PERSEL_A) -> &'a mut W {
        unsafe { self.bits(variant.into()) }
    }
    #[doc = "No peripheral selected."]
    #[inline(always)]
    pub fn no_periph_selected(self) -> &'a mut W {
        self.variant(PERSEL_A::NO_PERIPH_SELECTED)
    }
    #[doc = "USART function selected."]
    #[inline(always)]
    pub fn usart(self) -> &'a mut W {
        self.variant(PERSEL_A::USART)
    }
    #[doc = "SPI function selected."]
    #[inline(always)]
    pub fn spi(self) -> &'a mut W {
        self.variant(PERSEL_A::SPI)
    }
    #[doc = "I2C function selected."]
    #[inline(always)]
    pub fn i2c(self) -> &'a mut W {
        self.variant(PERSEL_A::I2C)
    }
    #[doc = "I2S transmit function selected."]
    #[inline(always)]
    pub fn i2s_transmit(self) -> &'a mut W {
        self.variant(PERSEL_A::I2S_TRANSMIT)
    }
    #[doc = "I2S receive function selected."]
    #[inline(always)]
    pub fn i2s_receive(self) -> &'a mut W {
        self.variant(PERSEL_A::I2S_RECEIVE)
    }
    #[doc = r"Writes raw bits to the field"]
    #[inline(always)]
    pub unsafe fn bits(self, value: u8) -> &'a mut W {
        self.w.bits = (self.w.bits & !0x07) | (value as u32 & 0x07);
        self.w
    }
}
#[doc = "Lock the peripheral select. This field is writable by software.\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum LOCK_A {
    #[doc = "0: Peripheral select can be changed by software."]
    UNLOCKED = 0,
    #[doc = "1: Peripheral select is locked and cannot be changed until this Flexcomm or the entire device is reset."]
    LOCKED = 1,
}
impl From<LOCK_A> for bool {
    #[inline(always)]
    fn from(variant: LOCK_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `LOCK` reader - Lock the peripheral select. This field is writable by software."]
pub struct LOCK_R(crate::FieldReader<bool, LOCK_A>);
impl LOCK_R {
    #[inline(always)]
    pub(crate) fn new(bits: bool) -> Self {
        LOCK_R(crate::FieldReader::new(bits))
    }
    #[doc = r"Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> LOCK_A {
        match self.bits {
            false => LOCK_A::UNLOCKED,
            true => LOCK_A::LOCKED,
        }
    }
    #[doc = "Checks if the value of the field is `UNLOCKED`"]
    #[inline(always)]
    pub fn is_unlocked(&self) -> bool {
        **self == LOCK_A::UNLOCKED
    }
    #[doc = "Checks if the value of the field is `LOCKED`"]
    #[inline(always)]
    pub fn is_locked(&self) -> bool {
        **self == LOCK_A::LOCKED
    }
}
impl core::ops::Deref for LOCK_R {
    type Target = crate::FieldReader<bool, LOCK_A>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
#[doc = "Field `LOCK` writer - Lock the peripheral select. This field is writable by software."]
pub struct LOCK_W<'a> {
    w: &'a mut W,
}
impl<'a> LOCK_W<'a> {
    #[doc = r"Writes `variant` to the field"]
    #[inline(always)]
    pub fn variant(self, variant: LOCK_A) -> &'a mut W {
        self.bit(variant.into())
    }
    #[doc = "Peripheral select can be changed by software."]
    #[inline(always)]
    pub fn unlocked(self) -> &'a mut W {
        self.variant(LOCK_A::UNLOCKED)
    }
    #[doc = "Peripheral select is locked and cannot be changed until this Flexcomm or the entire device is reset."]
    #[inline(always)]
    pub fn locked(self) -> &'a mut W {
        self.variant(LOCK_A::LOCKED)
    }
    #[doc = r"Sets the field bit"]
    #[inline(always)]
    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }
    #[doc = r"Clears the field bit"]
    #[inline(always)]
    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
    #[doc = r"Writes raw bits to the field"]
    #[inline(always)]
    pub fn bit(self, value: bool) -> &'a mut W {
        self.w.bits = (self.w.bits & !(0x01 << 3)) | ((value as u32 & 0x01) << 3);
        self.w
    }
}
#[doc = "USART present indicator. This field is Read-only.\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum USARTPRESENT_A {
    #[doc = "0: This Flexcomm does not include the USART function."]
    NOT_PRESENT = 0,
    #[doc = "1: This Flexcomm includes the USART function."]
    PRESENT = 1,
}
impl From<USARTPRESENT_A> for bool {
    #[inline(always)]
    fn from(variant: USARTPRESENT_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `USARTPRESENT` reader - USART present indicator. This field is Read-only."]
pub struct USARTPRESENT_R(crate::FieldReader<bool, USARTPRESENT_A>);
impl USARTPRESENT_R {
    #[inline(always)]
    pub(crate) fn new(bits: bool) -> Self {
        USARTPRESENT_R(crate::FieldReader::new(bits))
    }
    #[doc = r"Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> USARTPRESENT_A {
        match self.bits {
            false => USARTPRESENT_A::NOT_PRESENT,
            true => USARTPRESENT_A::PRESENT,
        }
    }
    #[doc = "Checks if the value of the field is `NOT_PRESENT`"]
    #[inline(always)]
    pub fn is_not_present(&self) -> bool {
        **self == USARTPRESENT_A::NOT_PRESENT
    }
    #[doc = "Checks if the value of the field is `PRESENT`"]
    #[inline(always)]
    pub fn is_present(&self) -> bool {
        **self == USARTPRESENT_A::PRESENT
    }
}
impl core::ops::Deref for USARTPRESENT_R {
    type Target = crate::FieldReader<bool, USARTPRESENT_A>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
#[doc = "SPI present indicator. This field is Read-only.\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum SPIPRESENT_A {
    #[doc = "0: This Flexcomm does not include the SPI function."]
    NOT_PRESENT = 0,
    #[doc = "1: This Flexcomm includes the SPI function."]
    PRESENT = 1,
}
impl From<SPIPRESENT_A> for bool {
    #[inline(always)]
    fn from(variant: SPIPRESENT_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `SPIPRESENT` reader - SPI present indicator. This field is Read-only."]
pub struct SPIPRESENT_R(crate::FieldReader<bool, SPIPRESENT_A>);
impl SPIPRESENT_R {
    #[inline(always)]
    pub(crate) fn new(bits: bool) -> Self {
        SPIPRESENT_R(crate::FieldReader::new(bits))
    }
    #[doc = r"Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> SPIPRESENT_A {
        match self.bits {
            false => SPIPRESENT_A::NOT_PRESENT,
            true => SPIPRESENT_A::PRESENT,
        }
    }
    #[doc = "Checks if the value of the field is `NOT_PRESENT`"]
    #[inline(always)]
    pub fn is_not_present(&self) -> bool {
        **self == SPIPRESENT_A::NOT_PRESENT
    }
    #[doc = "Checks if the value of the field is `PRESENT`"]
    #[inline(always)]
    pub fn is_present(&self) -> bool {
        **self == SPIPRESENT_A::PRESENT
    }
}
impl core::ops::Deref for SPIPRESENT_R {
    type Target = crate::FieldReader<bool, SPIPRESENT_A>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
#[doc = "I2C present indicator. This field is Read-only.\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum I2CPRESENT_A {
    #[doc = "0: This Flexcomm does not include the I2C function."]
    NOT_PRESENT = 0,
    #[doc = "1: This Flexcomm includes the I2C function."]
    PRESENT = 1,
}
impl From<I2CPRESENT_A> for bool {
    #[inline(always)]
    fn from(variant: I2CPRESENT_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `I2CPRESENT` reader - I2C present indicator. This field is Read-only."]
pub struct I2CPRESENT_R(crate::FieldReader<bool, I2CPRESENT_A>);
impl I2CPRESENT_R {
    #[inline(always)]
    pub(crate) fn new(bits: bool) -> Self {
        I2CPRESENT_R(crate::FieldReader::new(bits))
    }
    #[doc = r"Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> I2CPRESENT_A {
        match self.bits {
            false => I2CPRESENT_A::NOT_PRESENT,
            true => I2CPRESENT_A::PRESENT,
        }
    }
    #[doc = "Checks if the value of the field is `NOT_PRESENT`"]
    #[inline(always)]
    pub fn is_not_present(&self) -> bool {
        **self == I2CPRESENT_A::NOT_PRESENT
    }
    #[doc = "Checks if the value of the field is `PRESENT`"]
    #[inline(always)]
    pub fn is_present(&self) -> bool {
        **self == I2CPRESENT_A::PRESENT
    }
}
impl core::ops::Deref for I2CPRESENT_R {
    type Target = crate::FieldReader<bool, I2CPRESENT_A>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
#[doc = "I 2S present indicator. This field is Read-only.\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum I2SPRESENT_A {
    #[doc = "0: This Flexcomm does not include the I2S function."]
    NOT_PRESENT = 0,
    #[doc = "1: This Flexcomm includes the I2S function."]
    PRESENT = 1,
}
impl From<I2SPRESENT_A> for bool {
    #[inline(always)]
    fn from(variant: I2SPRESENT_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `I2SPRESENT` reader - I 2S present indicator. This field is Read-only."]
pub struct I2SPRESENT_R(crate::FieldReader<bool, I2SPRESENT_A>);
impl I2SPRESENT_R {
    #[inline(always)]
    pub(crate) fn new(bits: bool) -> Self {
        I2SPRESENT_R(crate::FieldReader::new(bits))
    }
    #[doc = r"Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> I2SPRESENT_A {
        match self.bits {
            false => I2SPRESENT_A::NOT_PRESENT,
            true => I2SPRESENT_A::PRESENT,
        }
    }
    #[doc = "Checks if the value of the field is `NOT_PRESENT`"]
    #[inline(always)]
    pub fn is_not_present(&self) -> bool {
        **self == I2SPRESENT_A::NOT_PRESENT
    }
    #[doc = "Checks if the value of the field is `PRESENT`"]
    #[inline(always)]
    pub fn is_present(&self) -> bool {
        **self == I2SPRESENT_A::PRESENT
    }
}
impl core::ops::Deref for I2SPRESENT_R {
    type Target = crate::FieldReader<bool, I2SPRESENT_A>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
#[doc = "Field `ID` reader - Flexcomm ID."]
pub struct ID_R(crate::FieldReader<u32, u32>);
impl ID_R {
    #[inline(always)]
    pub(crate) fn new(bits: u32) -> Self {
        ID_R(crate::FieldReader::new(bits))
    }
}
impl core::ops::Deref for ID_R {
    type Target = crate::FieldReader<u32, u32>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl R {
    #[doc = "Bits 0:2 - Peripheral Select. This field is writable by software."]
    #[inline(always)]
    pub fn persel(&self) -> PERSEL_R {
        PERSEL_R::new((self.bits & 0x07) as u8)
    }
    #[doc = "Bit 3 - Lock the peripheral select. This field is writable by software."]
    #[inline(always)]
    pub fn lock(&self) -> LOCK_R {
        LOCK_R::new(((self.bits >> 3) & 0x01) != 0)
    }
    #[doc = "Bit 4 - USART present indicator. This field is Read-only."]
    #[inline(always)]
    pub fn usartpresent(&self) -> USARTPRESENT_R {
        USARTPRESENT_R::new(((self.bits >> 4) & 0x01) != 0)
    }
    #[doc = "Bit 5 - SPI present indicator. This field is Read-only."]
    #[inline(always)]
    pub fn spipresent(&self) -> SPIPRESENT_R {
        SPIPRESENT_R::new(((self.bits >> 5) & 0x01) != 0)
    }
    #[doc = "Bit 6 - I2C present indicator. This field is Read-only."]
    #[inline(always)]
    pub fn i2cpresent(&self) -> I2CPRESENT_R {
        I2CPRESENT_R::new(((self.bits >> 6) & 0x01) != 0)
    }
    #[doc = "Bit 7 - I 2S present indicator. This field is Read-only."]
    #[inline(always)]
    pub fn i2spresent(&self) -> I2SPRESENT_R {
        I2SPRESENT_R::new(((self.bits >> 7) & 0x01) != 0)
    }
    #[doc = "Bits 12:31 - Flexcomm ID."]
    #[inline(always)]
    pub fn id(&self) -> ID_R {
        ID_R::new(((self.bits >> 12) & 0x000f_ffff) as u32)
    }
}
impl W {
    #[doc = "Bits 0:2 - Peripheral Select. This field is writable by software."]
    #[inline(always)]
    pub fn persel(&mut self) -> PERSEL_W {
        PERSEL_W { w: self }
    }
    #[doc = "Bit 3 - Lock the peripheral select. This field is writable by software."]
    #[inline(always)]
    pub fn lock(&mut self) -> LOCK_W {
        LOCK_W { w: self }
    }
    #[doc = "Writes raw bits to the register."]
    #[inline(always)]
    pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
        self.0.bits(bits);
        self
    }
}
#[doc = "Peripheral Select and Flexcomm ID register.\n\nThis register you can [`read`](crate::generic::Reg::read), [`write_with_zero`](crate::generic::Reg::write_with_zero), [`reset`](crate::generic::Reg::reset), [`write`](crate::generic::Reg::write), [`modify`](crate::generic::Reg::modify). See [API](https://docs.rs/svd2rust/#read--modify--write-api).\n\nFor information about available fields see [pselid](index.html) module"]
pub struct PSELID_SPEC;
impl crate::RegisterSpec for PSELID_SPEC {
    type Ux = u32;
}
#[doc = "`read()` method returns [pselid::R](R) reader structure"]
impl crate::Readable for PSELID_SPEC {
    type Reader = R;
}
#[doc = "`write(|w| ..)` method takes [pselid::W](W) writer structure"]
impl crate::Writable for PSELID_SPEC {
    type Writer = W;
}
#[doc = "`reset()` method sets PSELID to value 0x0010_1000"]
impl crate::Resettable for PSELID_SPEC {
    #[inline(always)]
    fn reset_value() -> Self::Ux {
        0x0010_1000
    }
}