ra2e1 0.2.0

Peripheral access API for ra2e1 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
#[doc = "Register `CTSUCRB` reader"]
pub struct R(crate::R<CTSUCRB_SPEC>);
impl core::ops::Deref for R {
    type Target = crate::R<CTSUCRB_SPEC>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl From<crate::R<CTSUCRB_SPEC>> for R {
    #[inline(always)]
    fn from(reader: crate::R<CTSUCRB_SPEC>) -> Self {
        R(reader)
    }
}
#[doc = "Register `CTSUCRB` writer"]
pub struct W(crate::W<CTSUCRB_SPEC>);
impl core::ops::Deref for W {
    type Target = crate::W<CTSUCRB_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<CTSUCRB_SPEC>> for W {
    #[inline(always)]
    fn from(writer: crate::W<CTSUCRB_SPEC>) -> Self {
        W(writer)
    }
}
#[doc = "Field `PRRATIO` reader - Frequency of Drive Pulse Phase Control"]
pub type PRRATIO_R = crate::FieldReader<u8, u8>;
#[doc = "Field `PRRATIO` writer - Frequency of Drive Pulse Phase Control"]
pub type PRRATIO_W<'a, const O: u8> = crate::FieldWriter<'a, u32, CTSUCRB_SPEC, u8, u8, 4, O>;
#[doc = "Field `PRMODE` reader - Phase Control Period"]
pub type PRMODE_R = crate::FieldReader<u8, PRMODE_A>;
#[doc = "Phase Control Period\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum PRMODE_A {
    #[doc = "0: 510 pulses (512 pulses when PROFF = 1)"]
    _00 = 0,
    #[doc = "1: 126 pulses (128 pulses when PROFF = 1)"]
    _01 = 1,
    #[doc = "2: 62 pulses (64 pulses when PROFF = 1)"]
    _10 = 2,
    #[doc = "3: Setting prohibited"]
    _11 = 3,
}
impl From<PRMODE_A> for u8 {
    #[inline(always)]
    fn from(variant: PRMODE_A) -> Self {
        variant as _
    }
}
impl PRMODE_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> PRMODE_A {
        match self.bits {
            0 => PRMODE_A::_00,
            1 => PRMODE_A::_01,
            2 => PRMODE_A::_10,
            3 => PRMODE_A::_11,
            _ => unreachable!(),
        }
    }
    #[doc = "Checks if the value of the field is `_00`"]
    #[inline(always)]
    pub fn is_00(&self) -> bool {
        *self == PRMODE_A::_00
    }
    #[doc = "Checks if the value of the field is `_01`"]
    #[inline(always)]
    pub fn is_01(&self) -> bool {
        *self == PRMODE_A::_01
    }
    #[doc = "Checks if the value of the field is `_10`"]
    #[inline(always)]
    pub fn is_10(&self) -> bool {
        *self == PRMODE_A::_10
    }
    #[doc = "Checks if the value of the field is `_11`"]
    #[inline(always)]
    pub fn is_11(&self) -> bool {
        *self == PRMODE_A::_11
    }
}
#[doc = "Field `PRMODE` writer - Phase Control Period"]
pub type PRMODE_W<'a, const O: u8> =
    crate::FieldWriterSafe<'a, u32, CTSUCRB_SPEC, u8, PRMODE_A, 2, O>;
impl<'a, const O: u8> PRMODE_W<'a, O> {
    #[doc = "510 pulses (512 pulses when PROFF = 1)"]
    #[inline(always)]
    pub fn _00(self) -> &'a mut W {
        self.variant(PRMODE_A::_00)
    }
    #[doc = "126 pulses (128 pulses when PROFF = 1)"]
    #[inline(always)]
    pub fn _01(self) -> &'a mut W {
        self.variant(PRMODE_A::_01)
    }
    #[doc = "62 pulses (64 pulses when PROFF = 1)"]
    #[inline(always)]
    pub fn _10(self) -> &'a mut W {
        self.variant(PRMODE_A::_10)
    }
    #[doc = "Setting prohibited"]
    #[inline(always)]
    pub fn _11(self) -> &'a mut W {
        self.variant(PRMODE_A::_11)
    }
}
#[doc = "Field `SOFF` reader - High-Pass Noise Reduction Function Disable"]
pub type SOFF_R = crate::BitReader<SOFF_A>;
#[doc = "High-Pass Noise Reduction Function Disable\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum SOFF_A {
    #[doc = "0: Turn the spread spectrum on"]
    _0 = 0,
    #[doc = "1: Turn the spread spectrum off"]
    _1 = 1,
}
impl From<SOFF_A> for bool {
    #[inline(always)]
    fn from(variant: SOFF_A) -> Self {
        variant as u8 != 0
    }
}
impl SOFF_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> SOFF_A {
        match self.bits {
            false => SOFF_A::_0,
            true => SOFF_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == SOFF_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == SOFF_A::_1
    }
}
#[doc = "Field `SOFF` writer - High-Pass Noise Reduction Function Disable"]
pub type SOFF_W<'a, const O: u8> = crate::BitWriter<'a, u32, CTSUCRB_SPEC, SOFF_A, O>;
impl<'a, const O: u8> SOFF_W<'a, O> {
    #[doc = "Turn the spread spectrum on"]
    #[inline(always)]
    pub fn _0(self) -> &'a mut W {
        self.variant(SOFF_A::_0)
    }
    #[doc = "Turn the spread spectrum off"]
    #[inline(always)]
    pub fn _1(self) -> &'a mut W {
        self.variant(SOFF_A::_1)
    }
}
#[doc = "Field `PROFF` reader - Drive Pulse Phase Control"]
pub type PROFF_R = crate::BitReader<PROFF_A>;
#[doc = "Drive Pulse Phase Control\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PROFF_A {
    #[doc = "0: The drive pulse phase is controlled by random numbers."]
    _0 = 0,
    #[doc = "1: The drive pulse phase is not controlled by random numbers."]
    _1 = 1,
}
impl From<PROFF_A> for bool {
    #[inline(always)]
    fn from(variant: PROFF_A) -> Self {
        variant as u8 != 0
    }
}
impl PROFF_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> PROFF_A {
        match self.bits {
            false => PROFF_A::_0,
            true => PROFF_A::_1,
        }
    }
    #[doc = "Checks if the value of the field is `_0`"]
    #[inline(always)]
    pub fn is_0(&self) -> bool {
        *self == PROFF_A::_0
    }
    #[doc = "Checks if the value of the field is `_1`"]
    #[inline(always)]
    pub fn is_1(&self) -> bool {
        *self == PROFF_A::_1
    }
}
#[doc = "Field `PROFF` writer - Drive Pulse Phase Control"]
pub type PROFF_W<'a, const O: u8> = crate::BitWriter<'a, u32, CTSUCRB_SPEC, PROFF_A, O>;
impl<'a, const O: u8> PROFF_W<'a, O> {
    #[doc = "The drive pulse phase is controlled by random numbers."]
    #[inline(always)]
    pub fn _0(self) -> &'a mut W {
        self.variant(PROFF_A::_0)
    }
    #[doc = "The drive pulse phase is not controlled by random numbers."]
    #[inline(always)]
    pub fn _1(self) -> &'a mut W {
        self.variant(PROFF_A::_1)
    }
}
#[doc = "Field `SST` reader - Wait Time Sensor Stabilization"]
pub type SST_R = crate::FieldReader<u8, u8>;
#[doc = "Field `SST` writer - Wait Time Sensor Stabilization"]
pub type SST_W<'a, const O: u8> = crate::FieldWriter<'a, u32, CTSUCRB_SPEC, u8, u8, 8, O>;
#[doc = "Field `SSMOD` reader - Spread Spectrum Modulation Frequency"]
pub type SSMOD_R = crate::FieldReader<u8, SSMOD_A>;
#[doc = "Spread Spectrum Modulation Frequency\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum SSMOD_A {
    #[doc = "0: 125 kHz (recommended)"]
    _000 = 0,
    #[doc = "1: 83.3 kHz"]
    _001 = 1,
    #[doc = "2: 62.5 kHz"]
    _010 = 2,
    #[doc = "3: 31.3 kHz"]
    _011 = 3,
}
impl From<SSMOD_A> for u8 {
    #[inline(always)]
    fn from(variant: SSMOD_A) -> Self {
        variant as _
    }
}
impl SSMOD_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> Option<SSMOD_A> {
        match self.bits {
            0 => Some(SSMOD_A::_000),
            1 => Some(SSMOD_A::_001),
            2 => Some(SSMOD_A::_010),
            3 => Some(SSMOD_A::_011),
            _ => None,
        }
    }
    #[doc = "Checks if the value of the field is `_000`"]
    #[inline(always)]
    pub fn is_000(&self) -> bool {
        *self == SSMOD_A::_000
    }
    #[doc = "Checks if the value of the field is `_001`"]
    #[inline(always)]
    pub fn is_001(&self) -> bool {
        *self == SSMOD_A::_001
    }
    #[doc = "Checks if the value of the field is `_010`"]
    #[inline(always)]
    pub fn is_010(&self) -> bool {
        *self == SSMOD_A::_010
    }
    #[doc = "Checks if the value of the field is `_011`"]
    #[inline(always)]
    pub fn is_011(&self) -> bool {
        *self == SSMOD_A::_011
    }
}
#[doc = "Field `SSMOD` writer - Spread Spectrum Modulation Frequency"]
pub type SSMOD_W<'a, const O: u8> = crate::FieldWriter<'a, u32, CTSUCRB_SPEC, u8, SSMOD_A, 3, O>;
impl<'a, const O: u8> SSMOD_W<'a, O> {
    #[doc = "125 kHz (recommended)"]
    #[inline(always)]
    pub fn _000(self) -> &'a mut W {
        self.variant(SSMOD_A::_000)
    }
    #[doc = "83.3 kHz"]
    #[inline(always)]
    pub fn _001(self) -> &'a mut W {
        self.variant(SSMOD_A::_001)
    }
    #[doc = "62.5 kHz"]
    #[inline(always)]
    pub fn _010(self) -> &'a mut W {
        self.variant(SSMOD_A::_010)
    }
    #[doc = "31.3 kHz"]
    #[inline(always)]
    pub fn _011(self) -> &'a mut W {
        self.variant(SSMOD_A::_011)
    }
}
#[doc = "Field `SSCNT` reader - Adjusting the SUCLK frequency"]
pub type SSCNT_R = crate::FieldReader<u8, SSCNT_A>;
#[doc = "Adjusting the SUCLK frequency\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum SSCNT_A {
    #[doc = "0: CTSUTRIMA.SUADJD + 0x00 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x00 (SDPSEL = 1)"]
    _00 = 0,
    #[doc = "1: CTSUTRIMA.SUADJD + 0x10 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x20 (SDPSEL = 1)"]
    _01 = 1,
    #[doc = "2: CTSUTRIMA.SUADJD + 0x20 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x40 (SDPSEL = 1)"]
    _10 = 2,
    #[doc = "3: CTSUTRIMA.SUADJD + 0x30 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x40 (SDPSEL = 1)"]
    _11 = 3,
}
impl From<SSCNT_A> for u8 {
    #[inline(always)]
    fn from(variant: SSCNT_A) -> Self {
        variant as _
    }
}
impl SSCNT_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> SSCNT_A {
        match self.bits {
            0 => SSCNT_A::_00,
            1 => SSCNT_A::_01,
            2 => SSCNT_A::_10,
            3 => SSCNT_A::_11,
            _ => unreachable!(),
        }
    }
    #[doc = "Checks if the value of the field is `_00`"]
    #[inline(always)]
    pub fn is_00(&self) -> bool {
        *self == SSCNT_A::_00
    }
    #[doc = "Checks if the value of the field is `_01`"]
    #[inline(always)]
    pub fn is_01(&self) -> bool {
        *self == SSCNT_A::_01
    }
    #[doc = "Checks if the value of the field is `_10`"]
    #[inline(always)]
    pub fn is_10(&self) -> bool {
        *self == SSCNT_A::_10
    }
    #[doc = "Checks if the value of the field is `_11`"]
    #[inline(always)]
    pub fn is_11(&self) -> bool {
        *self == SSCNT_A::_11
    }
}
#[doc = "Field `SSCNT` writer - Adjusting the SUCLK frequency"]
pub type SSCNT_W<'a, const O: u8> =
    crate::FieldWriterSafe<'a, u32, CTSUCRB_SPEC, u8, SSCNT_A, 2, O>;
impl<'a, const O: u8> SSCNT_W<'a, O> {
    #[doc = "CTSUTRIMA.SUADJD + 0x00 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x00 (SDPSEL = 1)"]
    #[inline(always)]
    pub fn _00(self) -> &'a mut W {
        self.variant(SSCNT_A::_00)
    }
    #[doc = "CTSUTRIMA.SUADJD + 0x10 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x20 (SDPSEL = 1)"]
    #[inline(always)]
    pub fn _01(self) -> &'a mut W {
        self.variant(SSCNT_A::_01)
    }
    #[doc = "CTSUTRIMA.SUADJD + 0x20 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x40 (SDPSEL = 1)"]
    #[inline(always)]
    pub fn _10(self) -> &'a mut W {
        self.variant(SSCNT_A::_10)
    }
    #[doc = "CTSUTRIMA.SUADJD + 0x30 (SDPSEL = 0) CTSUSUCLKx.SUADJDn + 0x40 (SDPSEL = 1)"]
    #[inline(always)]
    pub fn _11(self) -> &'a mut W {
        self.variant(SSCNT_A::_11)
    }
}
impl R {
    #[doc = "Bits 0:3 - Frequency of Drive Pulse Phase Control"]
    #[inline(always)]
    pub fn prratio(&self) -> PRRATIO_R {
        PRRATIO_R::new((self.bits & 0x0f) as u8)
    }
    #[doc = "Bits 4:5 - Phase Control Period"]
    #[inline(always)]
    pub fn prmode(&self) -> PRMODE_R {
        PRMODE_R::new(((self.bits >> 4) & 3) as u8)
    }
    #[doc = "Bit 6 - High-Pass Noise Reduction Function Disable"]
    #[inline(always)]
    pub fn soff(&self) -> SOFF_R {
        SOFF_R::new(((self.bits >> 6) & 1) != 0)
    }
    #[doc = "Bit 7 - Drive Pulse Phase Control"]
    #[inline(always)]
    pub fn proff(&self) -> PROFF_R {
        PROFF_R::new(((self.bits >> 7) & 1) != 0)
    }
    #[doc = "Bits 8:15 - Wait Time Sensor Stabilization"]
    #[inline(always)]
    pub fn sst(&self) -> SST_R {
        SST_R::new(((self.bits >> 8) & 0xff) as u8)
    }
    #[doc = "Bits 24:26 - Spread Spectrum Modulation Frequency"]
    #[inline(always)]
    pub fn ssmod(&self) -> SSMOD_R {
        SSMOD_R::new(((self.bits >> 24) & 7) as u8)
    }
    #[doc = "Bits 28:29 - Adjusting the SUCLK frequency"]
    #[inline(always)]
    pub fn sscnt(&self) -> SSCNT_R {
        SSCNT_R::new(((self.bits >> 28) & 3) as u8)
    }
}
impl W {
    #[doc = "Bits 0:3 - Frequency of Drive Pulse Phase Control"]
    #[inline(always)]
    #[must_use]
    pub fn prratio(&mut self) -> PRRATIO_W<0> {
        PRRATIO_W::new(self)
    }
    #[doc = "Bits 4:5 - Phase Control Period"]
    #[inline(always)]
    #[must_use]
    pub fn prmode(&mut self) -> PRMODE_W<4> {
        PRMODE_W::new(self)
    }
    #[doc = "Bit 6 - High-Pass Noise Reduction Function Disable"]
    #[inline(always)]
    #[must_use]
    pub fn soff(&mut self) -> SOFF_W<6> {
        SOFF_W::new(self)
    }
    #[doc = "Bit 7 - Drive Pulse Phase Control"]
    #[inline(always)]
    #[must_use]
    pub fn proff(&mut self) -> PROFF_W<7> {
        PROFF_W::new(self)
    }
    #[doc = "Bits 8:15 - Wait Time Sensor Stabilization"]
    #[inline(always)]
    #[must_use]
    pub fn sst(&mut self) -> SST_W<8> {
        SST_W::new(self)
    }
    #[doc = "Bits 24:26 - Spread Spectrum Modulation Frequency"]
    #[inline(always)]
    #[must_use]
    pub fn ssmod(&mut self) -> SSMOD_W<24> {
        SSMOD_W::new(self)
    }
    #[doc = "Bits 28:29 - Adjusting the SUCLK frequency"]
    #[inline(always)]
    #[must_use]
    pub fn sscnt(&mut self) -> SSCNT_W<28> {
        SSCNT_W::new(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 = "CTSU Control Register B\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 [ctsucrb](index.html) module"]
pub struct CTSUCRB_SPEC;
impl crate::RegisterSpec for CTSUCRB_SPEC {
    type Ux = u32;
}
#[doc = "`read()` method returns [ctsucrb::R](R) reader structure"]
impl crate::Readable for CTSUCRB_SPEC {
    type Reader = R;
}
#[doc = "`write(|w| ..)` method takes [ctsucrb::W](W) writer structure"]
impl crate::Writable for CTSUCRB_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 CTSUCRB to value 0"]
impl crate::Resettable for CTSUCRB_SPEC {
    const RESET_VALUE: Self::Ux = 0;
}