stm32-metapac 18.0.0

Peripheral Access Crate (PAC) for all STM32 chips, including metadata.
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
#![allow(clippy::missing_safety_doc)]
#![allow(clippy::identity_op)]
#![allow(clippy::unnecessary_cast)]
#![allow(clippy::erasing_op)]

#[doc = "CORDIC co-processor."]
#[derive(Copy, Clone, Eq, PartialEq)]
pub struct Cordic {
    ptr: *mut u8,
}
unsafe impl Send for Cordic {}
unsafe impl Sync for Cordic {}
impl Cordic {
    #[inline(always)]
    pub const unsafe fn from_ptr(ptr: *mut ()) -> Self {
        Self { ptr: ptr as _ }
    }
    #[inline(always)]
    pub const fn as_ptr(&self) -> *mut () {
        self.ptr as _
    }
    #[doc = "Control and status register."]
    #[inline(always)]
    pub const fn csr(self) -> crate::common::Reg<regs::Csr, crate::common::RW> {
        unsafe { crate::common::Reg::from_ptr(self.ptr.add(0x0usize) as _) }
    }
    #[doc = "Argument register."]
    #[inline(always)]
    pub const fn wdata(self) -> crate::common::Reg<u32, crate::common::RW> {
        unsafe { crate::common::Reg::from_ptr(self.ptr.add(0x04usize) as _) }
    }
    #[doc = "Result register."]
    #[inline(always)]
    pub const fn rdata(self) -> crate::common::Reg<u32, crate::common::RW> {
        unsafe { crate::common::Reg::from_ptr(self.ptr.add(0x08usize) as _) }
    }
}
pub mod regs {
    #[doc = "Control and status register."]
    #[repr(transparent)]
    #[derive(Copy, Clone, Eq, PartialEq)]
    pub struct Csr(pub u32);
    impl Csr {
        #[doc = "Function."]
        #[inline(always)]
        pub const fn func(&self) -> super::vals::Func {
            let val = (self.0 >> 0usize) & 0x0f;
            super::vals::Func::from_bits(val as u8)
        }
        #[doc = "Function."]
        #[inline(always)]
        pub fn set_func(&mut self, val: super::vals::Func) {
            self.0 = (self.0 & !(0x0f << 0usize)) | (((val.to_bits() as u32) & 0x0f) << 0usize);
        }
        #[doc = "Precision required (number of iterations/cycles), where PRECISION = (number of iterations/4)."]
        #[inline(always)]
        pub const fn precision(&self) -> super::vals::Precision {
            let val = (self.0 >> 4usize) & 0x0f;
            super::vals::Precision::from_bits(val as u8)
        }
        #[doc = "Precision required (number of iterations/cycles), where PRECISION = (number of iterations/4)."]
        #[inline(always)]
        pub fn set_precision(&mut self, val: super::vals::Precision) {
            self.0 = (self.0 & !(0x0f << 4usize)) | (((val.to_bits() as u32) & 0x0f) << 4usize);
        }
        #[doc = "Scaling factor. Input value has been multiplied by 2^(-n) before for argument. Output value will need to be multiplied by 2^n later for results."]
        #[inline(always)]
        pub const fn scale(&self) -> super::vals::Scale {
            let val = (self.0 >> 8usize) & 0x07;
            super::vals::Scale::from_bits(val as u8)
        }
        #[doc = "Scaling factor. Input value has been multiplied by 2^(-n) before for argument. Output value will need to be multiplied by 2^n later for results."]
        #[inline(always)]
        pub fn set_scale(&mut self, val: super::vals::Scale) {
            self.0 = (self.0 & !(0x07 << 8usize)) | (((val.to_bits() as u32) & 0x07) << 8usize);
        }
        #[doc = "Enable interrupt."]
        #[inline(always)]
        pub const fn ien(&self) -> bool {
            let val = (self.0 >> 16usize) & 0x01;
            val != 0
        }
        #[doc = "Enable interrupt."]
        #[inline(always)]
        pub fn set_ien(&mut self, val: bool) {
            self.0 = (self.0 & !(0x01 << 16usize)) | (((val as u32) & 0x01) << 16usize);
        }
        #[doc = "Enable DMA wread channel."]
        #[inline(always)]
        pub const fn dmaren(&self) -> bool {
            let val = (self.0 >> 17usize) & 0x01;
            val != 0
        }
        #[doc = "Enable DMA wread channel."]
        #[inline(always)]
        pub fn set_dmaren(&mut self, val: bool) {
            self.0 = (self.0 & !(0x01 << 17usize)) | (((val as u32) & 0x01) << 17usize);
        }
        #[doc = "Enable DMA write channel."]
        #[inline(always)]
        pub const fn dmawen(&self) -> bool {
            let val = (self.0 >> 18usize) & 0x01;
            val != 0
        }
        #[doc = "Enable DMA write channel."]
        #[inline(always)]
        pub fn set_dmawen(&mut self, val: bool) {
            self.0 = (self.0 & !(0x01 << 18usize)) | (((val as u32) & 0x01) << 18usize);
        }
        #[doc = "Number of results in the RDATA register."]
        #[inline(always)]
        pub const fn nres(&self) -> super::vals::Num {
            let val = (self.0 >> 19usize) & 0x01;
            super::vals::Num::from_bits(val as u8)
        }
        #[doc = "Number of results in the RDATA register."]
        #[inline(always)]
        pub fn set_nres(&mut self, val: super::vals::Num) {
            self.0 = (self.0 & !(0x01 << 19usize)) | (((val.to_bits() as u32) & 0x01) << 19usize);
        }
        #[doc = "Number of arguments expected by the WDATA register."]
        #[inline(always)]
        pub const fn nargs(&self) -> super::vals::Num {
            let val = (self.0 >> 20usize) & 0x01;
            super::vals::Num::from_bits(val as u8)
        }
        #[doc = "Number of arguments expected by the WDATA register."]
        #[inline(always)]
        pub fn set_nargs(&mut self, val: super::vals::Num) {
            self.0 = (self.0 & !(0x01 << 20usize)) | (((val.to_bits() as u32) & 0x01) << 20usize);
        }
        #[doc = "Width of output data."]
        #[inline(always)]
        pub const fn ressize(&self) -> super::vals::Size {
            let val = (self.0 >> 21usize) & 0x01;
            super::vals::Size::from_bits(val as u8)
        }
        #[doc = "Width of output data."]
        #[inline(always)]
        pub fn set_ressize(&mut self, val: super::vals::Size) {
            self.0 = (self.0 & !(0x01 << 21usize)) | (((val.to_bits() as u32) & 0x01) << 21usize);
        }
        #[doc = "Width of input data."]
        #[inline(always)]
        pub const fn argsize(&self) -> super::vals::Size {
            let val = (self.0 >> 22usize) & 0x01;
            super::vals::Size::from_bits(val as u8)
        }
        #[doc = "Width of input data."]
        #[inline(always)]
        pub fn set_argsize(&mut self, val: super::vals::Size) {
            self.0 = (self.0 & !(0x01 << 22usize)) | (((val.to_bits() as u32) & 0x01) << 22usize);
        }
        #[doc = "Result ready flag."]
        #[inline(always)]
        pub const fn rrdy(&self) -> bool {
            let val = (self.0 >> 31usize) & 0x01;
            val != 0
        }
        #[doc = "Result ready flag."]
        #[inline(always)]
        pub fn set_rrdy(&mut self, val: bool) {
            self.0 = (self.0 & !(0x01 << 31usize)) | (((val as u32) & 0x01) << 31usize);
        }
    }
    impl Default for Csr {
        #[inline(always)]
        fn default() -> Csr {
            Csr(0)
        }
    }
    impl core::fmt::Debug for Csr {
        fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
            f.debug_struct("Csr")
                .field("func", &self.func())
                .field("precision", &self.precision())
                .field("scale", &self.scale())
                .field("ien", &self.ien())
                .field("dmaren", &self.dmaren())
                .field("dmawen", &self.dmawen())
                .field("nres", &self.nres())
                .field("nargs", &self.nargs())
                .field("ressize", &self.ressize())
                .field("argsize", &self.argsize())
                .field("rrdy", &self.rrdy())
                .finish()
        }
    }
    #[cfg(feature = "defmt")]
    impl defmt::Format for Csr {
        fn format(&self, f: defmt::Formatter) {
            defmt :: write ! (f , "Csr {{ func: {:?}, precision: {:?}, scale: {:?}, ien: {=bool:?}, dmaren: {=bool:?}, dmawen: {=bool:?}, nres: {:?}, nargs: {:?}, ressize: {:?}, argsize: {:?}, rrdy: {=bool:?} }}" , self . func () , self . precision () , self . scale () , self . ien () , self . dmaren () , self . dmawen () , self . nres () , self . nargs () , self . ressize () , self . argsize () , self . rrdy ())
        }
    }
}
pub mod vals {
    #[repr(u8)]
    #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
    pub enum Func {
        #[doc = "Cosine function."]
        COSINE = 0x0,
        #[doc = "Sine function."]
        SINE = 0x01,
        #[doc = "Phase function."]
        PHASE = 0x02,
        #[doc = "Modulus function."]
        MODULUS = 0x03,
        #[doc = "Arctangent function."]
        ARCTANGENT = 0x04,
        #[doc = "Hyperbolic Cosine function."]
        HYPERBOLIC_COSINE = 0x05,
        #[doc = "Hyperbolic Sine function."]
        HYPERBOLIC_SINE = 0x06,
        #[doc = "Arctanh function."]
        ARCTANH = 0x07,
        #[doc = "Natural Logarithm function."]
        NATURAL_LOGARITHM = 0x08,
        #[doc = "Square Root function."]
        SQUARE_ROOT = 0x09,
        _RESERVED_a = 0x0a,
        _RESERVED_b = 0x0b,
        _RESERVED_c = 0x0c,
        _RESERVED_d = 0x0d,
        _RESERVED_e = 0x0e,
        _RESERVED_f = 0x0f,
    }
    impl Func {
        #[inline(always)]
        pub const fn from_bits(val: u8) -> Func {
            unsafe { core::mem::transmute(val & 0x0f) }
        }
        #[inline(always)]
        pub const fn to_bits(self) -> u8 {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl From<u8> for Func {
        #[inline(always)]
        fn from(val: u8) -> Func {
            Func::from_bits(val)
        }
    }
    impl From<Func> for u8 {
        #[inline(always)]
        fn from(val: Func) -> u8 {
            Func::to_bits(val)
        }
    }
    #[repr(u8)]
    #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
    pub enum Num {
        #[doc = "1 input/output"]
        NUM1 = 0x0,
        #[doc = "2 input/output"]
        NUM2 = 0x01,
    }
    impl Num {
        #[inline(always)]
        pub const fn from_bits(val: u8) -> Num {
            unsafe { core::mem::transmute(val & 0x01) }
        }
        #[inline(always)]
        pub const fn to_bits(self) -> u8 {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl From<u8> for Num {
        #[inline(always)]
        fn from(val: u8) -> Num {
            Num::from_bits(val)
        }
    }
    impl From<Num> for u8 {
        #[inline(always)]
        fn from(val: Num) -> u8 {
            Num::to_bits(val)
        }
    }
    #[repr(u8)]
    #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
    pub enum Precision {
        _RESERVED_0 = 0x0,
        #[doc = "4 iterations."]
        ITERS4 = 0x01,
        #[doc = "8 iterations."]
        ITERS8 = 0x02,
        #[doc = "12 iterations."]
        ITERS12 = 0x03,
        #[doc = "16 iterations."]
        ITERS16 = 0x04,
        #[doc = "20 iterations."]
        ITERS20 = 0x05,
        #[doc = "24 iterations."]
        ITERS24 = 0x06,
        #[doc = "28 iterations."]
        ITERS28 = 0x07,
        #[doc = "32 iterations."]
        ITERS32 = 0x08,
        #[doc = "36 iterations."]
        ITERS36 = 0x09,
        #[doc = "40 iterations."]
        ITERS40 = 0x0a,
        #[doc = "44 iterations."]
        ITERS44 = 0x0b,
        #[doc = "48 iterations."]
        ITERS48 = 0x0c,
        #[doc = "52 iterations."]
        ITERS52 = 0x0d,
        #[doc = "56 iterations."]
        ITERS56 = 0x0e,
        #[doc = "60 iterations."]
        ITERS60 = 0x0f,
    }
    impl Precision {
        #[inline(always)]
        pub const fn from_bits(val: u8) -> Precision {
            unsafe { core::mem::transmute(val & 0x0f) }
        }
        #[inline(always)]
        pub const fn to_bits(self) -> u8 {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl From<u8> for Precision {
        #[inline(always)]
        fn from(val: u8) -> Precision {
            Precision::from_bits(val)
        }
    }
    impl From<Precision> for u8 {
        #[inline(always)]
        fn from(val: Precision) -> u8 {
            Precision::to_bits(val)
        }
    }
    #[repr(u8)]
    #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
    pub enum Scale {
        #[doc = "Argument multiplied by 1, result multiplied by 1"]
        A1_R1 = 0x0,
        #[doc = "Argument multiplied by 1/2, result multiplied by 2"]
        A1O2_R2 = 0x01,
        #[doc = "Argument multiplied by 1/4, result multiplied by 4"]
        A1O4_R4 = 0x02,
        #[doc = "Argument multiplied by 1/8, result multiplied by 8"]
        A1O8_R8 = 0x03,
        #[doc = "Argument multiplied by 1/16, result multiplied by 16"]
        A1O16_R16 = 0x04,
        #[doc = "Argument multiplied by 1/32, result multiplied by 32"]
        A1O32_R32 = 0x05,
        #[doc = "Argument multiplied by 1/64, result multiplied by 64"]
        A1O64_R64 = 0x06,
        #[doc = "Argument multiplied by 1/128, result multiplied by 128"]
        A1O128_R128 = 0x07,
    }
    impl Scale {
        #[inline(always)]
        pub const fn from_bits(val: u8) -> Scale {
            unsafe { core::mem::transmute(val & 0x07) }
        }
        #[inline(always)]
        pub const fn to_bits(self) -> u8 {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl From<u8> for Scale {
        #[inline(always)]
        fn from(val: u8) -> Scale {
            Scale::from_bits(val)
        }
    }
    impl From<Scale> for u8 {
        #[inline(always)]
        fn from(val: Scale) -> u8 {
            Scale::to_bits(val)
        }
    }
    #[repr(u8)]
    #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
    pub enum Size {
        #[doc = "Use 32 bit input/output values."]
        BITS32 = 0x0,
        #[doc = "Use 16 bit input/output values."]
        BITS16 = 0x01,
    }
    impl Size {
        #[inline(always)]
        pub const fn from_bits(val: u8) -> Size {
            unsafe { core::mem::transmute(val & 0x01) }
        }
        #[inline(always)]
        pub const fn to_bits(self) -> u8 {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl From<u8> for Size {
        #[inline(always)]
        fn from(val: u8) -> Size {
            Size::from_bits(val)
        }
    }
    impl From<Size> for u8 {
        #[inline(always)]
        fn from(val: Size) -> u8 {
            Size::to_bits(val)
        }
    }
}