ra4m2 0.2.0

Peripheral access API for ra4m2 microcontrollers (generated using 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
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
#[doc = "Register `ICMR3` reader"]
pub struct R(crate::R<ICMR3_SPEC>);
impl core::ops::Deref for R {
    type Target = crate::R<ICMR3_SPEC>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl From<crate::R<ICMR3_SPEC>> for R {
    #[inline(always)]
    fn from(reader: crate::R<ICMR3_SPEC>) -> Self {
        R(reader)
    }
}
#[doc = "Register `ICMR3` writer"]
pub struct W(crate::W<ICMR3_SPEC>);
impl core::ops::Deref for W {
    type Target = crate::W<ICMR3_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<ICMR3_SPEC>> for W {
    #[inline(always)]
    fn from(writer: crate::W<ICMR3_SPEC>) -> Self {
        W(writer)
    }
}
#[doc = "Field `NF` reader - Noise Filter Stage Select"]
pub type NF_R = crate::FieldReader<u8, NF_A>;
#[doc = "Noise Filter Stage Select\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum NF_A {
    #[doc = "0: Filter out noise of up to 1 IIC-phi cycle (single-stage filter)"]
    _00 = 0,
    #[doc = "1: Filter out noise of up to 2 IIC-phi cycles (2-stage filter)"]
    _01 = 1,
    #[doc = "2: Filter out noise of up to 3 IIC-phi cycles (3-stage filter)"]
    _10 = 2,
    #[doc = "3: Filter out noise of up to 4 IIC-phi cycles (4-stage filter)"]
    _11 = 3,
}
impl From<NF_A> for u8 {
    #[inline(always)]
    fn from(variant: NF_A) -> Self {
        variant as _
    }
}
impl NF_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> NF_A {
        match self.bits {
            0 => NF_A::_00,
            1 => NF_A::_01,
            2 => NF_A::_10,
            3 => NF_A::_11,
            _ => unreachable!(),
        }
    }
    #[doc = "Checks if the value of the field is `_00`"]
    #[inline(always)]
    pub fn is_00(&self) -> bool {
        *self == NF_A::_00
    }
    #[doc = "Checks if the value of the field is `_01`"]
    #[inline(always)]
    pub fn is_01(&self) -> bool {
        *self == NF_A::_01
    }
    #[doc = "Checks if the value of the field is `_10`"]
    #[inline(always)]
    pub fn is_10(&self) -> bool {
        *self == NF_A::_10
    }
    #[doc = "Checks if the value of the field is `_11`"]
    #[inline(always)]
    pub fn is_11(&self) -> bool {
        *self == NF_A::_11
    }
}
#[doc = "Field `NF` writer - Noise Filter Stage Select"]
pub type NF_W<'a, const O: u8> = crate::FieldWriterSafe<'a, u8, ICMR3_SPEC, u8, NF_A, 2, O>;
impl<'a, const O: u8> NF_W<'a, O> {
    #[doc = "Filter out noise of up to 1 IIC-phi cycle (single-stage filter)"]
    #[inline(always)]
    pub fn _00(self) -> &'a mut W {
        self.variant(NF_A::_00)
    }
    #[doc = "Filter out noise of up to 2 IIC-phi cycles (2-stage filter)"]
    #[inline(always)]
    pub fn _01(self) -> &'a mut W {
        self.variant(NF_A::_01)
    }
    #[doc = "Filter out noise of up to 3 IIC-phi cycles (3-stage filter)"]
    #[inline(always)]
    pub fn _10(self) -> &'a mut W {
        self.variant(NF_A::_10)
    }
    #[doc = "Filter out noise of up to 4 IIC-phi cycles (4-stage filter)"]
    #[inline(always)]
    pub fn _11(self) -> &'a mut W {
        self.variant(NF_A::_11)
    }
}
#[doc = "Field `ACKBR` reader - Receive Acknowledge"]
pub type ACKBR_R = crate::BitReader<ACKBR_A>;
#[doc = "Receive Acknowledge\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ACKBR_A {
    #[doc = "0: 0 received as the acknowledge bit (ACK reception)"]
    _0 = 0,
    #[doc = "1: 1 received as the acknowledge bit (NACK reception)"]
    _1 = 1,
}
impl From<ACKBR_A> for bool {
    #[inline(always)]
    fn from(variant: ACKBR_A) -> Self {
        variant as u8 != 0
    }
}
impl ACKBR_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> ACKBR_A {
        match self.bits {
            false => ACKBR_A::_0,
            true => ACKBR_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == ACKBR_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == ACKBR_A::_1
    }
}
#[doc = "Field `ACKBT` reader - Transmit Acknowledge"]
pub type ACKBT_R = crate::BitReader<ACKBT_A>;
#[doc = "Transmit Acknowledge\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ACKBT_A {
    #[doc = "0: Send 0 as the acknowledge bit (ACK transmission)"]
    _0 = 0,
    #[doc = "1: Send 1 as the acknowledge bit (NACK transmission)"]
    _1 = 1,
}
impl From<ACKBT_A> for bool {
    #[inline(always)]
    fn from(variant: ACKBT_A) -> Self {
        variant as u8 != 0
    }
}
impl ACKBT_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> ACKBT_A {
        match self.bits {
            false => ACKBT_A::_0,
            true => ACKBT_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == ACKBT_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == ACKBT_A::_1
    }
}
#[doc = "Field `ACKBT` writer - Transmit Acknowledge"]
pub type ACKBT_W<'a, const O: u8> = crate::BitWriter<'a, u8, ICMR3_SPEC, ACKBT_A, O>;
impl<'a, const O: u8> ACKBT_W<'a, O> {
    #[doc = "Send 0 as the acknowledge bit (ACK transmission)"]
    #[inline(always)]
    pub fn _0(self) -> &'a mut W {
        self.variant(ACKBT_A::_0)
    }
    #[doc = "Send 1 as the acknowledge bit (NACK transmission)"]
    #[inline(always)]
    pub fn _1(self) -> &'a mut W {
        self.variant(ACKBT_A::_1)
    }
}
#[doc = "Field `ACKWP` reader - ACKBT Write Protect"]
pub type ACKWP_R = crate::BitReader<ACKWP_A>;
#[doc = "ACKBT Write Protect\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ACKWP_A {
    #[doc = "0: Write protect ACKBT bit"]
    _0 = 0,
    #[doc = "1: Write enable ACKBT bit"]
    _1 = 1,
}
impl From<ACKWP_A> for bool {
    #[inline(always)]
    fn from(variant: ACKWP_A) -> Self {
        variant as u8 != 0
    }
}
impl ACKWP_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> ACKWP_A {
        match self.bits {
            false => ACKWP_A::_0,
            true => ACKWP_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == ACKWP_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == ACKWP_A::_1
    }
}
#[doc = "Field `ACKWP` writer - ACKBT Write Protect"]
pub type ACKWP_W<'a, const O: u8> = crate::BitWriter<'a, u8, ICMR3_SPEC, ACKWP_A, O>;
impl<'a, const O: u8> ACKWP_W<'a, O> {
    #[doc = "Write protect ACKBT bit"]
    #[inline(always)]
    pub fn _0(self) -> &'a mut W {
        self.variant(ACKWP_A::_0)
    }
    #[doc = "Write enable ACKBT bit"]
    #[inline(always)]
    pub fn _1(self) -> &'a mut W {
        self.variant(ACKWP_A::_1)
    }
}
#[doc = "Field `RDRFS` reader - RDRF Flag Set Timing Select"]
pub type RDRFS_R = crate::BitReader<RDRFS_A>;
#[doc = "RDRF Flag Set Timing Select\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum RDRFS_A {
    #[doc = "0: Set the RDRF flag on the rising edge of the 9th SCL clock cycle. The SCLn line is not held low on the falling edge of the 8th clock cycle."]
    _0 = 0,
    #[doc = "1: Set the RDRF flag on the rising edge of the 8th SCL clock cycle. The SCLn line is held low on the falling edge of the 8th clock cycle."]
    _1 = 1,
}
impl From<RDRFS_A> for bool {
    #[inline(always)]
    fn from(variant: RDRFS_A) -> Self {
        variant as u8 != 0
    }
}
impl RDRFS_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> RDRFS_A {
        match self.bits {
            false => RDRFS_A::_0,
            true => RDRFS_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == RDRFS_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == RDRFS_A::_1
    }
}
#[doc = "Field `RDRFS` writer - RDRF Flag Set Timing Select"]
pub type RDRFS_W<'a, const O: u8> = crate::BitWriter<'a, u8, ICMR3_SPEC, RDRFS_A, O>;
impl<'a, const O: u8> RDRFS_W<'a, O> {
    #[doc = "Set the RDRF flag on the rising edge of the 9th SCL clock cycle. The SCLn line is not held low on the falling edge of the 8th clock cycle."]
    #[inline(always)]
    pub fn _0(self) -> &'a mut W {
        self.variant(RDRFS_A::_0)
    }
    #[doc = "Set the RDRF flag on the rising edge of the 8th SCL clock cycle. The SCLn line is held low on the falling edge of the 8th clock cycle."]
    #[inline(always)]
    pub fn _1(self) -> &'a mut W {
        self.variant(RDRFS_A::_1)
    }
}
#[doc = "Field `WAIT` reader - Low-hold is released by reading ICDRR."]
pub type WAIT_R = crate::BitReader<WAIT_A>;
#[doc = "Low-hold is released by reading ICDRR.\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum WAIT_A {
    #[doc = "0: No wait (The SCLn line is not held low during the period between the 9th clock cycle and the 1st clock cycle.)"]
    _0 = 0,
    #[doc = "1: Wait (The SCLn line is held low during the period between the 9th clock cycle and the 1st clock cycle.)"]
    _1 = 1,
}
impl From<WAIT_A> for bool {
    #[inline(always)]
    fn from(variant: WAIT_A) -> Self {
        variant as u8 != 0
    }
}
impl WAIT_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> WAIT_A {
        match self.bits {
            false => WAIT_A::_0,
            true => WAIT_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == WAIT_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == WAIT_A::_1
    }
}
#[doc = "Field `WAIT` writer - Low-hold is released by reading ICDRR."]
pub type WAIT_W<'a, const O: u8> = crate::BitWriter<'a, u8, ICMR3_SPEC, WAIT_A, O>;
impl<'a, const O: u8> WAIT_W<'a, O> {
    #[doc = "No wait (The SCLn line is not held low during the period between the 9th clock cycle and the 1st clock cycle.)"]
    #[inline(always)]
    pub fn _0(self) -> &'a mut W {
        self.variant(WAIT_A::_0)
    }
    #[doc = "Wait (The SCLn line is held low during the period between the 9th clock cycle and the 1st clock cycle.)"]
    #[inline(always)]
    pub fn _1(self) -> &'a mut W {
        self.variant(WAIT_A::_1)
    }
}
#[doc = "Field `SMBS` reader - SMBus/I2C Bus Select"]
pub type SMBS_R = crate::BitReader<SMBS_A>;
#[doc = "SMBus/I2C Bus Select\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum SMBS_A {
    #[doc = "0: Select I2C Bus"]
    _0 = 0,
    #[doc = "1: Select SMBus"]
    _1 = 1,
}
impl From<SMBS_A> for bool {
    #[inline(always)]
    fn from(variant: SMBS_A) -> Self {
        variant as u8 != 0
    }
}
impl SMBS_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> SMBS_A {
        match self.bits {
            false => SMBS_A::_0,
            true => SMBS_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == SMBS_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == SMBS_A::_1
    }
}
#[doc = "Field `SMBS` writer - SMBus/I2C Bus Select"]
pub type SMBS_W<'a, const O: u8> = crate::BitWriter<'a, u8, ICMR3_SPEC, SMBS_A, O>;
impl<'a, const O: u8> SMBS_W<'a, O> {
    #[doc = "Select I2C Bus"]
    #[inline(always)]
    pub fn _0(self) -> &'a mut W {
        self.variant(SMBS_A::_0)
    }
    #[doc = "Select SMBus"]
    #[inline(always)]
    pub fn _1(self) -> &'a mut W {
        self.variant(SMBS_A::_1)
    }
}
impl R {
    #[doc = "Bits 0:1 - Noise Filter Stage Select"]
    #[inline(always)]
    pub fn nf(&self) -> NF_R {
        NF_R::new(self.bits & 3)
    }
    #[doc = "Bit 2 - Receive Acknowledge"]
    #[inline(always)]
    pub fn ackbr(&self) -> ACKBR_R {
        ACKBR_R::new(((self.bits >> 2) & 1) != 0)
    }
    #[doc = "Bit 3 - Transmit Acknowledge"]
    #[inline(always)]
    pub fn ackbt(&self) -> ACKBT_R {
        ACKBT_R::new(((self.bits >> 3) & 1) != 0)
    }
    #[doc = "Bit 4 - ACKBT Write Protect"]
    #[inline(always)]
    pub fn ackwp(&self) -> ACKWP_R {
        ACKWP_R::new(((self.bits >> 4) & 1) != 0)
    }
    #[doc = "Bit 5 - RDRF Flag Set Timing Select"]
    #[inline(always)]
    pub fn rdrfs(&self) -> RDRFS_R {
        RDRFS_R::new(((self.bits >> 5) & 1) != 0)
    }
    #[doc = "Bit 6 - Low-hold is released by reading ICDRR."]
    #[inline(always)]
    pub fn wait(&self) -> WAIT_R {
        WAIT_R::new(((self.bits >> 6) & 1) != 0)
    }
    #[doc = "Bit 7 - SMBus/I2C Bus Select"]
    #[inline(always)]
    pub fn smbs(&self) -> SMBS_R {
        SMBS_R::new(((self.bits >> 7) & 1) != 0)
    }
}
impl W {
    #[doc = "Bits 0:1 - Noise Filter Stage Select"]
    #[inline(always)]
    #[must_use]
    pub fn nf(&mut self) -> NF_W<0> {
        NF_W::new(self)
    }
    #[doc = "Bit 3 - Transmit Acknowledge"]
    #[inline(always)]
    #[must_use]
    pub fn ackbt(&mut self) -> ACKBT_W<3> {
        ACKBT_W::new(self)
    }
    #[doc = "Bit 4 - ACKBT Write Protect"]
    #[inline(always)]
    #[must_use]
    pub fn ackwp(&mut self) -> ACKWP_W<4> {
        ACKWP_W::new(self)
    }
    #[doc = "Bit 5 - RDRF Flag Set Timing Select"]
    #[inline(always)]
    #[must_use]
    pub fn rdrfs(&mut self) -> RDRFS_W<5> {
        RDRFS_W::new(self)
    }
    #[doc = "Bit 6 - Low-hold is released by reading ICDRR."]
    #[inline(always)]
    #[must_use]
    pub fn wait(&mut self) -> WAIT_W<6> {
        WAIT_W::new(self)
    }
    #[doc = "Bit 7 - SMBus/I2C Bus Select"]
    #[inline(always)]
    #[must_use]
    pub fn smbs(&mut self) -> SMBS_W<7> {
        SMBS_W::new(self)
    }
    #[doc = "Writes raw bits to the register."]
    #[inline(always)]
    pub unsafe fn bits(&mut self, bits: u8) -> &mut Self {
        self.0.bits(bits);
        self
    }
}
#[doc = "I2C Bus Mode Register 3\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 [icmr3](index.html) module"]
pub struct ICMR3_SPEC;
impl crate::RegisterSpec for ICMR3_SPEC {
    type Ux = u8;
}
#[doc = "`read()` method returns [icmr3::R](R) reader structure"]
impl crate::Readable for ICMR3_SPEC {
    type Reader = R;
}
#[doc = "`write(|w| ..)` method takes [icmr3::W](W) writer structure"]
impl crate::Writable for ICMR3_SPEC {
    type Writer = W;
    const ZERO_TO_MODIFY_FIELDS_BITMAP: Self::Ux = 0;
    const ONE_TO_MODIFY_FIELDS_BITMAP: Self::Ux = 0;
}
#[doc = "`reset()` method sets ICMR3 to value 0"]
impl crate::Resettable for ICMR3_SPEC {
    const RESET_VALUE: Self::Ux = 0;
}