lpc43xx 0.1.0

Register definitions for the NXP LPC43xx microcontroller platform, generated through svd2rust
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
#[doc = r" Value read from the register"]
pub struct R {
    bits: u32,
}
#[doc = r" Value to write to the register"]
pub struct W {
    bits: u32,
}
impl super::IF_ARB2 {
    #[doc = r" Modifies the contents of the register"]
    #[inline]
    pub fn modify<F>(&self, f: F)
    where
        for<'w> F: FnOnce(&R, &'w mut W) -> &'w mut W,
    {
        let bits = self.register.get();
        let r = R { bits: bits };
        let mut w = W { bits: bits };
        f(&r, &mut w);
        self.register.set(w.bits);
    }
    #[doc = r" Reads the contents of the register"]
    #[inline]
    pub fn read(&self) -> R {
        R {
            bits: self.register.get(),
        }
    }
    #[doc = r" Writes to the register"]
    #[inline]
    pub fn write<F>(&self, f: F)
    where
        F: FnOnce(&mut W) -> &mut W,
    {
        let mut w = W::reset_value();
        f(&mut w);
        self.register.set(w.bits);
    }
    #[doc = r" Writes the reset value to the register"]
    #[inline]
    pub fn reset(&self) {
        self.write(|w| w)
    }
}
#[doc = r" Value of the field"]
pub struct ID28_16R {
    bits: u16,
}
impl ID28_16R {
    #[doc = r" Value of the field as raw bits"]
    #[inline]
    pub fn bits(&self) -> u16 {
        self.bits
    }
}
#[doc = "Possible values of the field `DIR`"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum DIRR {
    #[doc = "Direction = transmit. On TXRQST, the respective Message Object is transmitted as a Data Frame. On reception of a Remote Frame with matching identifier, the TXRQST bit of this Message Object is set (if RMTEN = one)."]
    DIRECTION_EQ_TRANSMIT,
    #[doc = "Direction = receive. On TXRQST, a Remote Frame with the identifier of this Message Object is transmitted. On reception of a Data Frame with matching identifier, that message is stored in this Message Object."]
    DIRECTION_EQ_RECEIVE,
}
impl DIRR {
    #[doc = r" Returns `true` if the bit is clear (0)"]
    #[inline]
    pub fn bit_is_clear(&self) -> bool {
        !self.bit()
    }
    #[doc = r" Returns `true` if the bit is set (1)"]
    #[inline]
    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }
    #[doc = r" Value of the field as raw bits"]
    #[inline]
    pub fn bit(&self) -> bool {
        match *self {
            DIRR::DIRECTION_EQ_TRANSMIT => true,
            DIRR::DIRECTION_EQ_RECEIVE => false,
        }
    }
    #[allow(missing_docs)]
    #[doc(hidden)]
    #[inline]
    pub fn _from(value: bool) -> DIRR {
        match value {
            true => DIRR::DIRECTION_EQ_TRANSMIT,
            false => DIRR::DIRECTION_EQ_RECEIVE,
        }
    }
    #[doc = "Checks if the value of the field is `DIRECTION_EQ_TRANSMIT`"]
    #[inline]
    pub fn is_direction_eq_transmit(&self) -> bool {
        *self == DIRR::DIRECTION_EQ_TRANSMIT
    }
    #[doc = "Checks if the value of the field is `DIRECTION_EQ_RECEIVE`"]
    #[inline]
    pub fn is_direction_eq_receive(&self) -> bool {
        *self == DIRR::DIRECTION_EQ_RECEIVE
    }
}
#[doc = "Possible values of the field `XTD`"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum XTDR {
    #[doc = "The 29-bit extended identifier will be used for this message object."]
    THE_29_BIT_EXTENDED,
    #[doc = "The 11-bit standard identifier will be used for this message object."]
    THE_11_BIT_STANDARD,
}
impl XTDR {
    #[doc = r" Returns `true` if the bit is clear (0)"]
    #[inline]
    pub fn bit_is_clear(&self) -> bool {
        !self.bit()
    }
    #[doc = r" Returns `true` if the bit is set (1)"]
    #[inline]
    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }
    #[doc = r" Value of the field as raw bits"]
    #[inline]
    pub fn bit(&self) -> bool {
        match *self {
            XTDR::THE_29_BIT_EXTENDED => true,
            XTDR::THE_11_BIT_STANDARD => false,
        }
    }
    #[allow(missing_docs)]
    #[doc(hidden)]
    #[inline]
    pub fn _from(value: bool) -> XTDR {
        match value {
            true => XTDR::THE_29_BIT_EXTENDED,
            false => XTDR::THE_11_BIT_STANDARD,
        }
    }
    #[doc = "Checks if the value of the field is `THE_29_BIT_EXTENDED`"]
    #[inline]
    pub fn is_the_29_bit_extended(&self) -> bool {
        *self == XTDR::THE_29_BIT_EXTENDED
    }
    #[doc = "Checks if the value of the field is `THE_11_BIT_STANDARD`"]
    #[inline]
    pub fn is_the_11_bit_standard(&self) -> bool {
        *self == XTDR::THE_11_BIT_STANDARD
    }
}
#[doc = "Possible values of the field `MSGVAL`"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum MSGVALR {
    #[doc = "The message object is configured and should be considered by the message handler."]
    THE_MESSAGE_OBJECT_I_1,
    #[doc = "The message object is ignored by the message handler."]
    THE_MESSAGE_OBJECT_I_2,
}
impl MSGVALR {
    #[doc = r" Returns `true` if the bit is clear (0)"]
    #[inline]
    pub fn bit_is_clear(&self) -> bool {
        !self.bit()
    }
    #[doc = r" Returns `true` if the bit is set (1)"]
    #[inline]
    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }
    #[doc = r" Value of the field as raw bits"]
    #[inline]
    pub fn bit(&self) -> bool {
        match *self {
            MSGVALR::THE_MESSAGE_OBJECT_I_1 => true,
            MSGVALR::THE_MESSAGE_OBJECT_I_2 => false,
        }
    }
    #[allow(missing_docs)]
    #[doc(hidden)]
    #[inline]
    pub fn _from(value: bool) -> MSGVALR {
        match value {
            true => MSGVALR::THE_MESSAGE_OBJECT_I_1,
            false => MSGVALR::THE_MESSAGE_OBJECT_I_2,
        }
    }
    #[doc = "Checks if the value of the field is `THE_MESSAGE_OBJECT_I_1`"]
    #[inline]
    pub fn is_the_message_object_i_1(&self) -> bool {
        *self == MSGVALR::THE_MESSAGE_OBJECT_I_1
    }
    #[doc = "Checks if the value of the field is `THE_MESSAGE_OBJECT_I_2`"]
    #[inline]
    pub fn is_the_message_object_i_2(&self) -> bool {
        *self == MSGVALR::THE_MESSAGE_OBJECT_I_2
    }
}
#[doc = r" Proxy"]
pub struct _ID28_16W<'a> {
    w: &'a mut W,
}
impl<'a> _ID28_16W<'a> {
    #[doc = r" Writes raw bits to the field"]
    #[inline]
    pub unsafe fn bits(self, value: u16) -> &'a mut W {
        const MASK: u16 = 8191;
        const OFFSET: u8 = 0;
        self.w.bits &= !((MASK as u32) << OFFSET);
        self.w.bits |= ((value & MASK) as u32) << OFFSET;
        self.w
    }
}
#[doc = "Values that can be written to the field `DIR`"]
pub enum DIRW {
    #[doc = "Direction = transmit. On TXRQST, the respective Message Object is transmitted as a Data Frame. On reception of a Remote Frame with matching identifier, the TXRQST bit of this Message Object is set (if RMTEN = one)."]
    DIRECTION_EQ_TRANSMIT,
    #[doc = "Direction = receive. On TXRQST, a Remote Frame with the identifier of this Message Object is transmitted. On reception of a Data Frame with matching identifier, that message is stored in this Message Object."]
    DIRECTION_EQ_RECEIVE,
}
impl DIRW {
    #[allow(missing_docs)]
    #[doc(hidden)]
    #[inline]
    pub fn _bits(&self) -> bool {
        match *self {
            DIRW::DIRECTION_EQ_TRANSMIT => true,
            DIRW::DIRECTION_EQ_RECEIVE => false,
        }
    }
}
#[doc = r" Proxy"]
pub struct _DIRW<'a> {
    w: &'a mut W,
}
impl<'a> _DIRW<'a> {
    #[doc = r" Writes `variant` to the field"]
    #[inline]
    pub fn variant(self, variant: DIRW) -> &'a mut W {
        {
            self.bit(variant._bits())
        }
    }
    #[doc = "Direction = transmit. On TXRQST, the respective Message Object is transmitted as a Data Frame. On reception of a Remote Frame with matching identifier, the TXRQST bit of this Message Object is set (if RMTEN = one)."]
    #[inline]
    pub fn direction_eq_transmit(self) -> &'a mut W {
        self.variant(DIRW::DIRECTION_EQ_TRANSMIT)
    }
    #[doc = "Direction = receive. On TXRQST, a Remote Frame with the identifier of this Message Object is transmitted. On reception of a Data Frame with matching identifier, that message is stored in this Message Object."]
    #[inline]
    pub fn direction_eq_receive(self) -> &'a mut W {
        self.variant(DIRW::DIRECTION_EQ_RECEIVE)
    }
    #[doc = r" Sets the field bit"]
    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }
    #[doc = r" Clears the field bit"]
    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
    #[doc = r" Writes raw bits to the field"]
    #[inline]
    pub fn bit(self, value: bool) -> &'a mut W {
        const MASK: bool = true;
        const OFFSET: u8 = 13;
        self.w.bits &= !((MASK as u32) << OFFSET);
        self.w.bits |= ((value & MASK) as u32) << OFFSET;
        self.w
    }
}
#[doc = "Values that can be written to the field `XTD`"]
pub enum XTDW {
    #[doc = "The 29-bit extended identifier will be used for this message object."]
    THE_29_BIT_EXTENDED,
    #[doc = "The 11-bit standard identifier will be used for this message object."]
    THE_11_BIT_STANDARD,
}
impl XTDW {
    #[allow(missing_docs)]
    #[doc(hidden)]
    #[inline]
    pub fn _bits(&self) -> bool {
        match *self {
            XTDW::THE_29_BIT_EXTENDED => true,
            XTDW::THE_11_BIT_STANDARD => false,
        }
    }
}
#[doc = r" Proxy"]
pub struct _XTDW<'a> {
    w: &'a mut W,
}
impl<'a> _XTDW<'a> {
    #[doc = r" Writes `variant` to the field"]
    #[inline]
    pub fn variant(self, variant: XTDW) -> &'a mut W {
        {
            self.bit(variant._bits())
        }
    }
    #[doc = "The 29-bit extended identifier will be used for this message object."]
    #[inline]
    pub fn the_29_bit_extended(self) -> &'a mut W {
        self.variant(XTDW::THE_29_BIT_EXTENDED)
    }
    #[doc = "The 11-bit standard identifier will be used for this message object."]
    #[inline]
    pub fn the_11_bit_standard(self) -> &'a mut W {
        self.variant(XTDW::THE_11_BIT_STANDARD)
    }
    #[doc = r" Sets the field bit"]
    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }
    #[doc = r" Clears the field bit"]
    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
    #[doc = r" Writes raw bits to the field"]
    #[inline]
    pub fn bit(self, value: bool) -> &'a mut W {
        const MASK: bool = true;
        const OFFSET: u8 = 14;
        self.w.bits &= !((MASK as u32) << OFFSET);
        self.w.bits |= ((value & MASK) as u32) << OFFSET;
        self.w
    }
}
#[doc = "Values that can be written to the field `MSGVAL`"]
pub enum MSGVALW {
    #[doc = "The message object is configured and should be considered by the message handler."]
    THE_MESSAGE_OBJECT_I_1,
    #[doc = "The message object is ignored by the message handler."]
    THE_MESSAGE_OBJECT_I_2,
}
impl MSGVALW {
    #[allow(missing_docs)]
    #[doc(hidden)]
    #[inline]
    pub fn _bits(&self) -> bool {
        match *self {
            MSGVALW::THE_MESSAGE_OBJECT_I_1 => true,
            MSGVALW::THE_MESSAGE_OBJECT_I_2 => false,
        }
    }
}
#[doc = r" Proxy"]
pub struct _MSGVALW<'a> {
    w: &'a mut W,
}
impl<'a> _MSGVALW<'a> {
    #[doc = r" Writes `variant` to the field"]
    #[inline]
    pub fn variant(self, variant: MSGVALW) -> &'a mut W {
        {
            self.bit(variant._bits())
        }
    }
    #[doc = "The message object is configured and should be considered by the message handler."]
    #[inline]
    pub fn the_message_object_i_1(self) -> &'a mut W {
        self.variant(MSGVALW::THE_MESSAGE_OBJECT_I_1)
    }
    #[doc = "The message object is ignored by the message handler."]
    #[inline]
    pub fn the_message_object_i_2(self) -> &'a mut W {
        self.variant(MSGVALW::THE_MESSAGE_OBJECT_I_2)
    }
    #[doc = r" Sets the field bit"]
    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }
    #[doc = r" Clears the field bit"]
    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
    #[doc = r" Writes raw bits to the field"]
    #[inline]
    pub fn bit(self, value: bool) -> &'a mut W {
        const MASK: bool = true;
        const OFFSET: u8 = 15;
        self.w.bits &= !((MASK as u32) << OFFSET);
        self.w.bits |= ((value & MASK) as u32) << OFFSET;
        self.w
    }
}
impl R {
    #[doc = r" Value of the register as raw bits"]
    #[inline]
    pub fn bits(&self) -> u32 {
        self.bits
    }
    #[doc = "Bits 0:12 - Message identifier 29-bit identifier (extended frame) 11-bit identifier (standard frame)"]
    #[inline]
    pub fn id28_16(&self) -> ID28_16R {
        let bits = {
            const MASK: u16 = 8191;
            const OFFSET: u8 = 0;
            ((self.bits >> OFFSET) & MASK as u32) as u16
        };
        ID28_16R { bits }
    }
    #[doc = "Bit 13 - Message direction"]
    #[inline]
    pub fn dir(&self) -> DIRR {
        DIRR::_from({
            const MASK: bool = true;
            const OFFSET: u8 = 13;
            ((self.bits >> OFFSET) & MASK as u32) != 0
        })
    }
    #[doc = "Bit 14 - Extend identifier"]
    #[inline]
    pub fn xtd(&self) -> XTDR {
        XTDR::_from({
            const MASK: bool = true;
            const OFFSET: u8 = 14;
            ((self.bits >> OFFSET) & MASK as u32) != 0
        })
    }
    #[doc = "Bit 15 - Message valid The CPU must reset the MSGVAL bit of all unused Messages Objects during the initialization before it resets bit INIT in the CAN Control Register. This bit must also be reset before the identifier ID28:0, the control bits XTD, DIR, or the Data Length Code DLC3:0 are modified, or if the Messages Object is no longer required."]
    #[inline]
    pub fn msgval(&self) -> MSGVALR {
        MSGVALR::_from({
            const MASK: bool = true;
            const OFFSET: u8 = 15;
            ((self.bits >> OFFSET) & MASK as u32) != 0
        })
    }
}
impl W {
    #[doc = r" Reset value of the register"]
    #[inline]
    pub fn reset_value() -> W {
        W { bits: 0 }
    }
    #[doc = r" Writes raw bits to the register"]
    #[inline]
    pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
        self.bits = bits;
        self
    }
    #[doc = "Bits 0:12 - Message identifier 29-bit identifier (extended frame) 11-bit identifier (standard frame)"]
    #[inline]
    pub fn id28_16(&mut self) -> _ID28_16W {
        _ID28_16W { w: self }
    }
    #[doc = "Bit 13 - Message direction"]
    #[inline]
    pub fn dir(&mut self) -> _DIRW {
        _DIRW { w: self }
    }
    #[doc = "Bit 14 - Extend identifier"]
    #[inline]
    pub fn xtd(&mut self) -> _XTDW {
        _XTDW { w: self }
    }
    #[doc = "Bit 15 - Message valid The CPU must reset the MSGVAL bit of all unused Messages Objects during the initialization before it resets bit INIT in the CAN Control Register. This bit must also be reset before the identifier ID28:0, the control bits XTD, DIR, or the Data Length Code DLC3:0 are modified, or if the Messages Object is no longer required."]
    #[inline]
    pub fn msgval(&mut self) -> _MSGVALW {
        _MSGVALW { w: self }
    }
}