max3263x 0.5.0

svd2rust generated peripheral crate for the max3263x
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
#[doc = "Register `GEN_CTRL` reader"]
pub struct R(crate::R<GEN_CTRL_SPEC>);
impl core::ops::Deref for R {
    type Target = crate::R<GEN_CTRL_SPEC>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl From<crate::R<GEN_CTRL_SPEC>> for R {
    #[inline(always)]
    fn from(reader: crate::R<GEN_CTRL_SPEC>) -> Self {
        R(reader)
    }
}
#[doc = "Register `GEN_CTRL` writer"]
pub struct W(crate::W<GEN_CTRL_SPEC>);
impl core::ops::Deref for W {
    type Target = crate::W<GEN_CTRL_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<GEN_CTRL_SPEC>> for W {
    #[inline(always)]
    fn from(writer: crate::W<GEN_CTRL_SPEC>) -> Self {
        W(writer)
    }
}
#[doc = "SPI Slave Enable\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum SPI_SLAVE_EN_A {
    #[doc = "0: Disable SPI Slave"]
    DISABLED = 0,
    #[doc = "1: Enable SPI Slave"]
    ENABLED = 1,
}
impl From<SPI_SLAVE_EN_A> for bool {
    #[inline(always)]
    fn from(variant: SPI_SLAVE_EN_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `spi_slave_en` reader - SPI Slave Enable"]
pub type SPI_SLAVE_EN_R = crate::BitReader<SPI_SLAVE_EN_A>;
impl SPI_SLAVE_EN_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> SPI_SLAVE_EN_A {
        match self.bits {
            false => SPI_SLAVE_EN_A::DISABLED,
            true => SPI_SLAVE_EN_A::ENABLED,
        }
    }
    #[doc = "Checks if the value of the field is `DISABLED`"]
    #[inline(always)]
    pub fn is_disabled(&self) -> bool {
        *self == SPI_SLAVE_EN_A::DISABLED
    }
    #[doc = "Checks if the value of the field is `ENABLED`"]
    #[inline(always)]
    pub fn is_enabled(&self) -> bool {
        *self == SPI_SLAVE_EN_A::ENABLED
    }
}
#[doc = "Field `spi_slave_en` writer - SPI Slave Enable"]
pub type SPI_SLAVE_EN_W<'a> = crate::BitWriter<'a, u32, GEN_CTRL_SPEC, SPI_SLAVE_EN_A, 0>;
impl<'a> SPI_SLAVE_EN_W<'a> {
    #[doc = "Disable SPI Slave"]
    #[inline(always)]
    pub fn disabled(self) -> &'a mut W {
        self.variant(SPI_SLAVE_EN_A::DISABLED)
    }
    #[doc = "Enable SPI Slave"]
    #[inline(always)]
    pub fn enabled(self) -> &'a mut W {
        self.variant(SPI_SLAVE_EN_A::ENABLED)
    }
}
#[doc = "TX FIFO Enable\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum TX_FIFO_EN_A {
    #[doc = "0: Disable SPI Slave TX FIFO"]
    DISABLED = 0,
    #[doc = "1: Enable SPI Slave TX FIFO"]
    ENABLED = 1,
}
impl From<TX_FIFO_EN_A> for bool {
    #[inline(always)]
    fn from(variant: TX_FIFO_EN_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `tx_fifo_en` reader - TX FIFO Enable"]
pub type TX_FIFO_EN_R = crate::BitReader<TX_FIFO_EN_A>;
impl TX_FIFO_EN_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> TX_FIFO_EN_A {
        match self.bits {
            false => TX_FIFO_EN_A::DISABLED,
            true => TX_FIFO_EN_A::ENABLED,
        }
    }
    #[doc = "Checks if the value of the field is `DISABLED`"]
    #[inline(always)]
    pub fn is_disabled(&self) -> bool {
        *self == TX_FIFO_EN_A::DISABLED
    }
    #[doc = "Checks if the value of the field is `ENABLED`"]
    #[inline(always)]
    pub fn is_enabled(&self) -> bool {
        *self == TX_FIFO_EN_A::ENABLED
    }
}
#[doc = "Field `tx_fifo_en` writer - TX FIFO Enable"]
pub type TX_FIFO_EN_W<'a> = crate::BitWriter<'a, u32, GEN_CTRL_SPEC, TX_FIFO_EN_A, 1>;
impl<'a> TX_FIFO_EN_W<'a> {
    #[doc = "Disable SPI Slave TX FIFO"]
    #[inline(always)]
    pub fn disabled(self) -> &'a mut W {
        self.variant(TX_FIFO_EN_A::DISABLED)
    }
    #[doc = "Enable SPI Slave TX FIFO"]
    #[inline(always)]
    pub fn enabled(self) -> &'a mut W {
        self.variant(TX_FIFO_EN_A::ENABLED)
    }
}
#[doc = "SPI RX FIFO Enable\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum RX_FIFO_EN_A {
    #[doc = "0: Disable SPI Slave RX FIFO"]
    DISABLED = 0,
    #[doc = "1: Enable SPI Slave RX FIFO"]
    ENABLED = 1,
}
impl From<RX_FIFO_EN_A> for bool {
    #[inline(always)]
    fn from(variant: RX_FIFO_EN_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `rx_fifo_en` reader - SPI RX FIFO Enable"]
pub type RX_FIFO_EN_R = crate::BitReader<RX_FIFO_EN_A>;
impl RX_FIFO_EN_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> RX_FIFO_EN_A {
        match self.bits {
            false => RX_FIFO_EN_A::DISABLED,
            true => RX_FIFO_EN_A::ENABLED,
        }
    }
    #[doc = "Checks if the value of the field is `DISABLED`"]
    #[inline(always)]
    pub fn is_disabled(&self) -> bool {
        *self == RX_FIFO_EN_A::DISABLED
    }
    #[doc = "Checks if the value of the field is `ENABLED`"]
    #[inline(always)]
    pub fn is_enabled(&self) -> bool {
        *self == RX_FIFO_EN_A::ENABLED
    }
}
#[doc = "Field `rx_fifo_en` writer - SPI RX FIFO Enable"]
pub type RX_FIFO_EN_W<'a> = crate::BitWriter<'a, u32, GEN_CTRL_SPEC, RX_FIFO_EN_A, 2>;
impl<'a> RX_FIFO_EN_W<'a> {
    #[doc = "Disable SPI Slave RX FIFO"]
    #[inline(always)]
    pub fn disabled(self) -> &'a mut W {
        self.variant(RX_FIFO_EN_A::DISABLED)
    }
    #[doc = "Enable SPI Slave RX FIFO"]
    #[inline(always)]
    pub fn enabled(self) -> &'a mut W {
        self.variant(RX_FIFO_EN_A::ENABLED)
    }
}
#[doc = "Width of SPI Slave Data Transfers\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(u8)]
pub enum DATA_WIDTH_A {
    #[doc = "0: 1-bit Wide"]
    X1 = 0,
    #[doc = "1: 2-bit Wide/Dual"]
    X2 = 1,
    #[doc = "2: 4-bit Wide/Quad"]
    X4 = 2,
    #[doc = "3: Reserved for future use. Do not use."]
    INVALID = 3,
}
impl From<DATA_WIDTH_A> for u8 {
    #[inline(always)]
    fn from(variant: DATA_WIDTH_A) -> Self {
        variant as _
    }
}
#[doc = "Field `data_width` reader - Width of SPI Slave Data Transfers"]
pub type DATA_WIDTH_R = crate::FieldReader<u8, DATA_WIDTH_A>;
impl DATA_WIDTH_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> DATA_WIDTH_A {
        match self.bits {
            0 => DATA_WIDTH_A::X1,
            1 => DATA_WIDTH_A::X2,
            2 => DATA_WIDTH_A::X4,
            3 => DATA_WIDTH_A::INVALID,
            _ => unreachable!(),
        }
    }
    #[doc = "Checks if the value of the field is `X1`"]
    #[inline(always)]
    pub fn is_x1(&self) -> bool {
        *self == DATA_WIDTH_A::X1
    }
    #[doc = "Checks if the value of the field is `X2`"]
    #[inline(always)]
    pub fn is_x2(&self) -> bool {
        *self == DATA_WIDTH_A::X2
    }
    #[doc = "Checks if the value of the field is `X4`"]
    #[inline(always)]
    pub fn is_x4(&self) -> bool {
        *self == DATA_WIDTH_A::X4
    }
    #[doc = "Checks if the value of the field is `INVALID`"]
    #[inline(always)]
    pub fn is_invalid(&self) -> bool {
        *self == DATA_WIDTH_A::INVALID
    }
}
#[doc = "Field `data_width` writer - Width of SPI Slave Data Transfers"]
pub type DATA_WIDTH_W<'a> = crate::FieldWriterSafe<'a, u32, GEN_CTRL_SPEC, u8, DATA_WIDTH_A, 2, 4>;
impl<'a> DATA_WIDTH_W<'a> {
    #[doc = "1-bit Wide"]
    #[inline(always)]
    pub fn x1(self) -> &'a mut W {
        self.variant(DATA_WIDTH_A::X1)
    }
    #[doc = "2-bit Wide/Dual"]
    #[inline(always)]
    pub fn x2(self) -> &'a mut W {
        self.variant(DATA_WIDTH_A::X2)
    }
    #[doc = "4-bit Wide/Quad"]
    #[inline(always)]
    pub fn x4(self) -> &'a mut W {
        self.variant(DATA_WIDTH_A::X4)
    }
    #[doc = "Reserved for future use. Do not use."]
    #[inline(always)]
    pub fn invalid(self) -> &'a mut W {
        self.variant(DATA_WIDTH_A::INVALID)
    }
}
#[doc = "Field `spi_mode` reader - Defines Clock Polarity (bit 17) and Clock Phase (bit 16), collectively referred to as SPI Mode."]
pub type SPI_MODE_R = crate::FieldReader<u8, u8>;
#[doc = "Field `spi_mode` writer - Defines Clock Polarity (bit 17) and Clock Phase (bit 16), collectively referred to as SPI Mode."]
pub type SPI_MODE_W<'a> = crate::FieldWriter<'a, u32, GEN_CTRL_SPEC, u8, u8, 2, 16>;
#[doc = "Invert TX Clock\n\nValue on reset: 0"]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum TX_CLK_INVERT_A {
    #[doc = "0: No Effect"]
    NO_EFFECT = 0,
    #[doc = "1: Inverts the TX transmit clock such that outgoing data is updated on the opposite clock edge from that specified by spi_mode. Effectively, this inverts the value of the Clock Polarity bit from the value specified in spi_mode."]
    INVERT = 1,
}
impl From<TX_CLK_INVERT_A> for bool {
    #[inline(always)]
    fn from(variant: TX_CLK_INVERT_A) -> Self {
        variant as u8 != 0
    }
}
#[doc = "Field `tx_clk_invert` reader - Invert TX Clock"]
pub type TX_CLK_INVERT_R = crate::BitReader<TX_CLK_INVERT_A>;
impl TX_CLK_INVERT_R {
    #[doc = "Get enumerated values variant"]
    #[inline(always)]
    pub fn variant(&self) -> TX_CLK_INVERT_A {
        match self.bits {
            false => TX_CLK_INVERT_A::NO_EFFECT,
            true => TX_CLK_INVERT_A::INVERT,
        }
    }
    #[doc = "Checks if the value of the field is `NO_EFFECT`"]
    #[inline(always)]
    pub fn is_no_effect(&self) -> bool {
        *self == TX_CLK_INVERT_A::NO_EFFECT
    }
    #[doc = "Checks if the value of the field is `INVERT`"]
    #[inline(always)]
    pub fn is_invert(&self) -> bool {
        *self == TX_CLK_INVERT_A::INVERT
    }
}
#[doc = "Field `tx_clk_invert` writer - Invert TX Clock"]
pub type TX_CLK_INVERT_W<'a> = crate::BitWriter<'a, u32, GEN_CTRL_SPEC, TX_CLK_INVERT_A, 20>;
impl<'a> TX_CLK_INVERT_W<'a> {
    #[doc = "No Effect"]
    #[inline(always)]
    pub fn no_effect(self) -> &'a mut W {
        self.variant(TX_CLK_INVERT_A::NO_EFFECT)
    }
    #[doc = "Inverts the TX transmit clock such that outgoing data is updated on the opposite clock edge from that specified by spi_mode. Effectively, this inverts the value of the Clock Polarity bit from the value specified in spi_mode."]
    #[inline(always)]
    pub fn invert(self) -> &'a mut W {
        self.variant(TX_CLK_INVERT_A::INVERT)
    }
}
#[doc = "Field `disable_parking` reader - Disable automatic resetting of SPI Slave on exit from LP Modes"]
pub type DISABLE_PARKING_R = crate::BitReader<bool>;
#[doc = "Field `disable_parking` writer - Disable automatic resetting of SPI Slave on exit from LP Modes"]
pub type DISABLE_PARKING_W<'a> = crate::BitWriter<'a, u32, GEN_CTRL_SPEC, bool, 31>;
impl R {
    #[doc = "Bit 0 - SPI Slave Enable"]
    #[inline(always)]
    pub fn spi_slave_en(&self) -> SPI_SLAVE_EN_R {
        SPI_SLAVE_EN_R::new((self.bits & 1) != 0)
    }
    #[doc = "Bit 1 - TX FIFO Enable"]
    #[inline(always)]
    pub fn tx_fifo_en(&self) -> TX_FIFO_EN_R {
        TX_FIFO_EN_R::new(((self.bits >> 1) & 1) != 0)
    }
    #[doc = "Bit 2 - SPI RX FIFO Enable"]
    #[inline(always)]
    pub fn rx_fifo_en(&self) -> RX_FIFO_EN_R {
        RX_FIFO_EN_R::new(((self.bits >> 2) & 1) != 0)
    }
    #[doc = "Bits 4:5 - Width of SPI Slave Data Transfers"]
    #[inline(always)]
    pub fn data_width(&self) -> DATA_WIDTH_R {
        DATA_WIDTH_R::new(((self.bits >> 4) & 3) as u8)
    }
    #[doc = "Bits 16:17 - Defines Clock Polarity (bit 17) and Clock Phase (bit 16), collectively referred to as SPI Mode."]
    #[inline(always)]
    pub fn spi_mode(&self) -> SPI_MODE_R {
        SPI_MODE_R::new(((self.bits >> 16) & 3) as u8)
    }
    #[doc = "Bit 20 - Invert TX Clock"]
    #[inline(always)]
    pub fn tx_clk_invert(&self) -> TX_CLK_INVERT_R {
        TX_CLK_INVERT_R::new(((self.bits >> 20) & 1) != 0)
    }
    #[doc = "Bit 31 - Disable automatic resetting of SPI Slave on exit from LP Modes"]
    #[inline(always)]
    pub fn disable_parking(&self) -> DISABLE_PARKING_R {
        DISABLE_PARKING_R::new(((self.bits >> 31) & 1) != 0)
    }
}
impl W {
    #[doc = "Bit 0 - SPI Slave Enable"]
    #[inline(always)]
    pub fn spi_slave_en(&mut self) -> SPI_SLAVE_EN_W {
        SPI_SLAVE_EN_W::new(self)
    }
    #[doc = "Bit 1 - TX FIFO Enable"]
    #[inline(always)]
    pub fn tx_fifo_en(&mut self) -> TX_FIFO_EN_W {
        TX_FIFO_EN_W::new(self)
    }
    #[doc = "Bit 2 - SPI RX FIFO Enable"]
    #[inline(always)]
    pub fn rx_fifo_en(&mut self) -> RX_FIFO_EN_W {
        RX_FIFO_EN_W::new(self)
    }
    #[doc = "Bits 4:5 - Width of SPI Slave Data Transfers"]
    #[inline(always)]
    pub fn data_width(&mut self) -> DATA_WIDTH_W {
        DATA_WIDTH_W::new(self)
    }
    #[doc = "Bits 16:17 - Defines Clock Polarity (bit 17) and Clock Phase (bit 16), collectively referred to as SPI Mode."]
    #[inline(always)]
    pub fn spi_mode(&mut self) -> SPI_MODE_W {
        SPI_MODE_W::new(self)
    }
    #[doc = "Bit 20 - Invert TX Clock"]
    #[inline(always)]
    pub fn tx_clk_invert(&mut self) -> TX_CLK_INVERT_W {
        TX_CLK_INVERT_W::new(self)
    }
    #[doc = "Bit 31 - Disable automatic resetting of SPI Slave on exit from LP Modes"]
    #[inline(always)]
    pub fn disable_parking(&mut self) -> DISABLE_PARKING_W {
        DISABLE_PARKING_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 = "SPI Slave General Control 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 [gen_ctrl](index.html) module"]
pub struct GEN_CTRL_SPEC;
impl crate::RegisterSpec for GEN_CTRL_SPEC {
    type Ux = u32;
}
#[doc = "`read()` method returns [gen_ctrl::R](R) reader structure"]
impl crate::Readable for GEN_CTRL_SPEC {
    type Reader = R;
}
#[doc = "`write(|w| ..)` method takes [gen_ctrl::W](W) writer structure"]
impl crate::Writable for GEN_CTRL_SPEC {
    type Writer = W;
}
#[doc = "`reset()` method sets GEN_CTRL to value 0"]
impl crate::Resettable for GEN_CTRL_SPEC {
    #[inline(always)]
    fn reset_value() -> Self::Ux {
        0
    }
}