stm32g0/stm32g030/tim14/
ccmr1_output.rs

1///Register `CCMR1_Output` reader
2pub type R = crate::R<CCMR1_OUTPUTrs>;
3///Register `CCMR1_Output` writer
4pub type W = crate::W<CCMR1_OUTPUTrs>;
5/**Capture/Compare %s selection
6
7Value on reset: 0*/
8#[cfg_attr(feature = "defmt", derive(defmt::Format))]
9#[derive(Clone, Copy, Debug, PartialEq, Eq)]
10#[repr(u8)]
11pub enum CC1S {
12    ///0: CCx channel is configured as output
13    Output = 0,
14}
15impl From<CC1S> for u8 {
16    #[inline(always)]
17    fn from(variant: CC1S) -> Self {
18        variant as _
19    }
20}
21impl crate::FieldSpec for CC1S {
22    type Ux = u8;
23}
24impl crate::IsEnum for CC1S {}
25///Field `CCS(1-1)` reader - Capture/Compare %s selection
26pub type CCS_R = crate::FieldReader<CC1S>;
27impl CCS_R {
28    ///Get enumerated values variant
29    #[inline(always)]
30    pub const fn variant(&self) -> Option<CC1S> {
31        match self.bits {
32            0 => Some(CC1S::Output),
33            _ => None,
34        }
35    }
36    ///CCx channel is configured as output
37    #[inline(always)]
38    pub fn is_output(&self) -> bool {
39        *self == CC1S::Output
40    }
41}
42///Field `CCS(1-1)` writer - Capture/Compare %s selection
43pub type CCS_W<'a, REG> = crate::FieldWriter<'a, REG, 2, CC1S>;
44impl<'a, REG> CCS_W<'a, REG>
45where
46    REG: crate::Writable + crate::RegisterSpec,
47    REG::Ux: From<u8>,
48{
49    ///CCx channel is configured as output
50    #[inline(always)]
51    pub fn output(self) -> &'a mut crate::W<REG> {
52        self.variant(CC1S::Output)
53    }
54}
55/**Output compare %s fast enable
56
57Value on reset: 0*/
58#[cfg_attr(feature = "defmt", derive(defmt::Format))]
59#[derive(Clone, Copy, Debug, PartialEq, Eq)]
60pub enum OC1FE {
61    ///0: Fast output disabled
62    Disabled = 0,
63    ///1: Fast output enabled
64    Enabled = 1,
65}
66impl From<OC1FE> for bool {
67    #[inline(always)]
68    fn from(variant: OC1FE) -> Self {
69        variant as u8 != 0
70    }
71}
72///Field `OCFE(1-1)` reader - Output compare %s fast enable
73pub type OCFE_R = crate::BitReader<OC1FE>;
74impl OCFE_R {
75    ///Get enumerated values variant
76    #[inline(always)]
77    pub const fn variant(&self) -> OC1FE {
78        match self.bits {
79            false => OC1FE::Disabled,
80            true => OC1FE::Enabled,
81        }
82    }
83    ///Fast output disabled
84    #[inline(always)]
85    pub fn is_disabled(&self) -> bool {
86        *self == OC1FE::Disabled
87    }
88    ///Fast output enabled
89    #[inline(always)]
90    pub fn is_enabled(&self) -> bool {
91        *self == OC1FE::Enabled
92    }
93}
94///Field `OCFE(1-1)` writer - Output compare %s fast enable
95pub type OCFE_W<'a, REG> = crate::BitWriter<'a, REG, OC1FE>;
96impl<'a, REG> OCFE_W<'a, REG>
97where
98    REG: crate::Writable + crate::RegisterSpec,
99{
100    ///Fast output disabled
101    #[inline(always)]
102    pub fn disabled(self) -> &'a mut crate::W<REG> {
103        self.variant(OC1FE::Disabled)
104    }
105    ///Fast output enabled
106    #[inline(always)]
107    pub fn enabled(self) -> &'a mut crate::W<REG> {
108        self.variant(OC1FE::Enabled)
109    }
110}
111/**Output compare %s preload enable
112
113Value on reset: 0*/
114#[cfg_attr(feature = "defmt", derive(defmt::Format))]
115#[derive(Clone, Copy, Debug, PartialEq, Eq)]
116pub enum OC1PE {
117    ///0: Preload register on CCRx disabled. New values written to CCRx are taken into account immediately
118    Disabled = 0,
119    ///1: Preload register on CCRx enabled. Preload value is loaded into active register on each update event
120    Enabled = 1,
121}
122impl From<OC1PE> for bool {
123    #[inline(always)]
124    fn from(variant: OC1PE) -> Self {
125        variant as u8 != 0
126    }
127}
128///Field `OCPE(1-1)` reader - Output compare %s preload enable
129pub type OCPE_R = crate::BitReader<OC1PE>;
130impl OCPE_R {
131    ///Get enumerated values variant
132    #[inline(always)]
133    pub const fn variant(&self) -> OC1PE {
134        match self.bits {
135            false => OC1PE::Disabled,
136            true => OC1PE::Enabled,
137        }
138    }
139    ///Preload register on CCRx disabled. New values written to CCRx are taken into account immediately
140    #[inline(always)]
141    pub fn is_disabled(&self) -> bool {
142        *self == OC1PE::Disabled
143    }
144    ///Preload register on CCRx enabled. Preload value is loaded into active register on each update event
145    #[inline(always)]
146    pub fn is_enabled(&self) -> bool {
147        *self == OC1PE::Enabled
148    }
149}
150///Field `OCPE(1-1)` writer - Output compare %s preload enable
151pub type OCPE_W<'a, REG> = crate::BitWriter<'a, REG, OC1PE>;
152impl<'a, REG> OCPE_W<'a, REG>
153where
154    REG: crate::Writable + crate::RegisterSpec,
155{
156    ///Preload register on CCRx disabled. New values written to CCRx are taken into account immediately
157    #[inline(always)]
158    pub fn disabled(self) -> &'a mut crate::W<REG> {
159        self.variant(OC1PE::Disabled)
160    }
161    ///Preload register on CCRx enabled. Preload value is loaded into active register on each update event
162    #[inline(always)]
163    pub fn enabled(self) -> &'a mut crate::W<REG> {
164        self.variant(OC1PE::Enabled)
165    }
166}
167/**Output compare %s mode
168
169Value on reset: 0*/
170#[cfg_attr(feature = "defmt", derive(defmt::Format))]
171#[derive(Clone, Copy, Debug, PartialEq, Eq)]
172#[repr(u8)]
173pub enum OC1M {
174    ///0: The comparison between the output compare register TIMx_CCRy and the counter TIMx_CNT has no effect on the outputs
175    Frozen = 0,
176    ///1: Set channel to active level on match. OCyREF signal is forced high when the counter matches the capture/compare register
177    ActiveOnMatch = 1,
178    ///2: Set channel to inactive level on match. OCyREF signal is forced low when the counter matches the capture/compare register
179    InactiveOnMatch = 2,
180    ///3: OCyREF toggles when TIMx_CNT=TIMx_CCRy
181    Toggle = 3,
182    ///4: OCyREF is forced low
183    ForceInactive = 4,
184    ///5: OCyREF is forced high
185    ForceActive = 5,
186    ///6: In upcounting, channel is active as long as TIMx_CNT<TIMx_CCRy else inactive. In downcounting, channel is inactive as long as TIMx_CNT>TIMx_CCRy else active
187    PwmMode1 = 6,
188    ///7: Inversely to PwmMode1
189    PwmMode2 = 7,
190}
191impl From<OC1M> for u8 {
192    #[inline(always)]
193    fn from(variant: OC1M) -> Self {
194        variant as _
195    }
196}
197impl crate::FieldSpec for OC1M {
198    type Ux = u8;
199}
200impl crate::IsEnum for OC1M {}
201///Field `OCM(1-1)` reader - Output compare %s mode
202pub type OCM_R = crate::FieldReader<OC1M>;
203impl OCM_R {
204    ///Get enumerated values variant
205    #[inline(always)]
206    pub const fn variant(&self) -> OC1M {
207        match self.bits {
208            0 => OC1M::Frozen,
209            1 => OC1M::ActiveOnMatch,
210            2 => OC1M::InactiveOnMatch,
211            3 => OC1M::Toggle,
212            4 => OC1M::ForceInactive,
213            5 => OC1M::ForceActive,
214            6 => OC1M::PwmMode1,
215            7 => OC1M::PwmMode2,
216            _ => unreachable!(),
217        }
218    }
219    ///The comparison between the output compare register TIMx_CCRy and the counter TIMx_CNT has no effect on the outputs
220    #[inline(always)]
221    pub fn is_frozen(&self) -> bool {
222        *self == OC1M::Frozen
223    }
224    ///Set channel to active level on match. OCyREF signal is forced high when the counter matches the capture/compare register
225    #[inline(always)]
226    pub fn is_active_on_match(&self) -> bool {
227        *self == OC1M::ActiveOnMatch
228    }
229    ///Set channel to inactive level on match. OCyREF signal is forced low when the counter matches the capture/compare register
230    #[inline(always)]
231    pub fn is_inactive_on_match(&self) -> bool {
232        *self == OC1M::InactiveOnMatch
233    }
234    ///OCyREF toggles when TIMx_CNT=TIMx_CCRy
235    #[inline(always)]
236    pub fn is_toggle(&self) -> bool {
237        *self == OC1M::Toggle
238    }
239    ///OCyREF is forced low
240    #[inline(always)]
241    pub fn is_force_inactive(&self) -> bool {
242        *self == OC1M::ForceInactive
243    }
244    ///OCyREF is forced high
245    #[inline(always)]
246    pub fn is_force_active(&self) -> bool {
247        *self == OC1M::ForceActive
248    }
249    ///In upcounting, channel is active as long as TIMx_CNT<TIMx_CCRy else inactive. In downcounting, channel is inactive as long as TIMx_CNT>TIMx_CCRy else active
250    #[inline(always)]
251    pub fn is_pwm_mode1(&self) -> bool {
252        *self == OC1M::PwmMode1
253    }
254    ///Inversely to PwmMode1
255    #[inline(always)]
256    pub fn is_pwm_mode2(&self) -> bool {
257        *self == OC1M::PwmMode2
258    }
259}
260///Field `OCM(1-1)` writer - Output compare %s mode
261pub type OCM_W<'a, REG> = crate::FieldWriter<'a, REG, 3, OC1M, crate::Safe>;
262impl<'a, REG> OCM_W<'a, REG>
263where
264    REG: crate::Writable + crate::RegisterSpec,
265    REG::Ux: From<u8>,
266{
267    ///The comparison between the output compare register TIMx_CCRy and the counter TIMx_CNT has no effect on the outputs
268    #[inline(always)]
269    pub fn frozen(self) -> &'a mut crate::W<REG> {
270        self.variant(OC1M::Frozen)
271    }
272    ///Set channel to active level on match. OCyREF signal is forced high when the counter matches the capture/compare register
273    #[inline(always)]
274    pub fn active_on_match(self) -> &'a mut crate::W<REG> {
275        self.variant(OC1M::ActiveOnMatch)
276    }
277    ///Set channel to inactive level on match. OCyREF signal is forced low when the counter matches the capture/compare register
278    #[inline(always)]
279    pub fn inactive_on_match(self) -> &'a mut crate::W<REG> {
280        self.variant(OC1M::InactiveOnMatch)
281    }
282    ///OCyREF toggles when TIMx_CNT=TIMx_CCRy
283    #[inline(always)]
284    pub fn toggle(self) -> &'a mut crate::W<REG> {
285        self.variant(OC1M::Toggle)
286    }
287    ///OCyREF is forced low
288    #[inline(always)]
289    pub fn force_inactive(self) -> &'a mut crate::W<REG> {
290        self.variant(OC1M::ForceInactive)
291    }
292    ///OCyREF is forced high
293    #[inline(always)]
294    pub fn force_active(self) -> &'a mut crate::W<REG> {
295        self.variant(OC1M::ForceActive)
296    }
297    ///In upcounting, channel is active as long as TIMx_CNT<TIMx_CCRy else inactive. In downcounting, channel is inactive as long as TIMx_CNT>TIMx_CCRy else active
298    #[inline(always)]
299    pub fn pwm_mode1(self) -> &'a mut crate::W<REG> {
300        self.variant(OC1M::PwmMode1)
301    }
302    ///Inversely to PwmMode1
303    #[inline(always)]
304    pub fn pwm_mode2(self) -> &'a mut crate::W<REG> {
305        self.variant(OC1M::PwmMode2)
306    }
307}
308///Field `OCCE(1-1)` reader - Output compare %s clear enable
309pub type OCCE_R = crate::BitReader;
310///Field `OCCE(1-1)` writer - Output compare %s clear enable
311pub type OCCE_W<'a, REG> = crate::BitWriter<'a, REG>;
312///Field `OCM_3(1-1)` reader - Output compare %s mode, bit 3
313pub type OCM_3_R = crate::BitReader;
314///Field `OCM_3(1-1)` writer - Output compare %s mode, bit 3
315pub type OCM_3_W<'a, REG> = crate::BitWriter<'a, REG>;
316impl R {
317    ///Capture/Compare (1-1) selection
318    ///
319    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `CC1S` field.</div>
320    #[inline(always)]
321    pub fn ccs(&self, n: u8) -> CCS_R {
322        #[allow(clippy::no_effect)]
323        [(); 1][n as usize];
324        CCS_R::new(((self.bits >> (n * 0)) & 3) as u8)
325    }
326    ///Iterator for array of:
327    ///Capture/Compare (1-1) selection
328    #[inline(always)]
329    pub fn ccs_iter(&self) -> impl Iterator<Item = CCS_R> + '_ {
330        (0..1).map(move |n| CCS_R::new(((self.bits >> (n * 0)) & 3) as u8))
331    }
332    ///Bits 0:1 - Capture/Compare 1 selection
333    #[inline(always)]
334    pub fn cc1s(&self) -> CCS_R {
335        CCS_R::new((self.bits & 3) as u8)
336    }
337    ///Output compare (1-1) fast enable
338    ///
339    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1FE` field.</div>
340    #[inline(always)]
341    pub fn ocfe(&self, n: u8) -> OCFE_R {
342        #[allow(clippy::no_effect)]
343        [(); 1][n as usize];
344        OCFE_R::new(((self.bits >> (n * 0 + 2)) & 1) != 0)
345    }
346    ///Iterator for array of:
347    ///Output compare (1-1) fast enable
348    #[inline(always)]
349    pub fn ocfe_iter(&self) -> impl Iterator<Item = OCFE_R> + '_ {
350        (0..1).map(move |n| OCFE_R::new(((self.bits >> (n * 0 + 2)) & 1) != 0))
351    }
352    ///Bit 2 - Output compare 1 fast enable
353    #[inline(always)]
354    pub fn oc1fe(&self) -> OCFE_R {
355        OCFE_R::new(((self.bits >> 2) & 1) != 0)
356    }
357    ///Output compare (1-1) preload enable
358    ///
359    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1PE` field.</div>
360    #[inline(always)]
361    pub fn ocpe(&self, n: u8) -> OCPE_R {
362        #[allow(clippy::no_effect)]
363        [(); 1][n as usize];
364        OCPE_R::new(((self.bits >> (n * 0 + 3)) & 1) != 0)
365    }
366    ///Iterator for array of:
367    ///Output compare (1-1) preload enable
368    #[inline(always)]
369    pub fn ocpe_iter(&self) -> impl Iterator<Item = OCPE_R> + '_ {
370        (0..1).map(move |n| OCPE_R::new(((self.bits >> (n * 0 + 3)) & 1) != 0))
371    }
372    ///Bit 3 - Output compare 1 preload enable
373    #[inline(always)]
374    pub fn oc1pe(&self) -> OCPE_R {
375        OCPE_R::new(((self.bits >> 3) & 1) != 0)
376    }
377    ///Output compare (1-1) mode
378    ///
379    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1M` field.</div>
380    #[inline(always)]
381    pub fn ocm(&self, n: u8) -> OCM_R {
382        #[allow(clippy::no_effect)]
383        [(); 1][n as usize];
384        OCM_R::new(((self.bits >> (n * 0 + 4)) & 7) as u8)
385    }
386    ///Iterator for array of:
387    ///Output compare (1-1) mode
388    #[inline(always)]
389    pub fn ocm_iter(&self) -> impl Iterator<Item = OCM_R> + '_ {
390        (0..1).map(move |n| OCM_R::new(((self.bits >> (n * 0 + 4)) & 7) as u8))
391    }
392    ///Bits 4:6 - Output compare 1 mode
393    #[inline(always)]
394    pub fn oc1m(&self) -> OCM_R {
395        OCM_R::new(((self.bits >> 4) & 7) as u8)
396    }
397    ///Output compare (1-1) clear enable
398    ///
399    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1CE` field.</div>
400    #[inline(always)]
401    pub fn occe(&self, n: u8) -> OCCE_R {
402        #[allow(clippy::no_effect)]
403        [(); 1][n as usize];
404        OCCE_R::new(((self.bits >> (n * 0 + 7)) & 1) != 0)
405    }
406    ///Iterator for array of:
407    ///Output compare (1-1) clear enable
408    #[inline(always)]
409    pub fn occe_iter(&self) -> impl Iterator<Item = OCCE_R> + '_ {
410        (0..1).map(move |n| OCCE_R::new(((self.bits >> (n * 0 + 7)) & 1) != 0))
411    }
412    ///Bit 7 - Output compare 1 clear enable
413    #[inline(always)]
414    pub fn oc1ce(&self) -> OCCE_R {
415        OCCE_R::new(((self.bits >> 7) & 1) != 0)
416    }
417    ///Output compare (1-1) mode, bit 3
418    ///
419    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1M_3` field.</div>
420    #[inline(always)]
421    pub fn ocm_3(&self, n: u8) -> OCM_3_R {
422        #[allow(clippy::no_effect)]
423        [(); 1][n as usize];
424        OCM_3_R::new(((self.bits >> (n * 0 + 16)) & 1) != 0)
425    }
426    ///Iterator for array of:
427    ///Output compare (1-1) mode, bit 3
428    #[inline(always)]
429    pub fn ocm_3_iter(&self) -> impl Iterator<Item = OCM_3_R> + '_ {
430        (0..1).map(move |n| OCM_3_R::new(((self.bits >> (n * 0 + 16)) & 1) != 0))
431    }
432    ///Bit 16 - Output compare 1 mode, bit 3
433    #[inline(always)]
434    pub fn oc1m_3(&self) -> OCM_3_R {
435        OCM_3_R::new(((self.bits >> 16) & 1) != 0)
436    }
437}
438impl core::fmt::Debug for R {
439    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
440        f.debug_struct("CCMR1_Output")
441            .field("cc1s", &self.cc1s())
442            .field("oc1fe", &self.oc1fe())
443            .field("oc1pe", &self.oc1pe())
444            .field("oc1m", &self.oc1m())
445            .field("oc1ce", &self.oc1ce())
446            .field("oc1m_3", &self.oc1m_3())
447            .finish()
448    }
449}
450impl W {
451    ///Capture/Compare (1-1) selection
452    ///
453    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `CC1S` field.</div>
454    #[inline(always)]
455    pub fn ccs(&mut self, n: u8) -> CCS_W<CCMR1_OUTPUTrs> {
456        #[allow(clippy::no_effect)]
457        [(); 1][n as usize];
458        CCS_W::new(self, n * 0)
459    }
460    ///Bits 0:1 - Capture/Compare 1 selection
461    #[inline(always)]
462    pub fn cc1s(&mut self) -> CCS_W<CCMR1_OUTPUTrs> {
463        CCS_W::new(self, 0)
464    }
465    ///Output compare (1-1) fast enable
466    ///
467    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1FE` field.</div>
468    #[inline(always)]
469    pub fn ocfe(&mut self, n: u8) -> OCFE_W<CCMR1_OUTPUTrs> {
470        #[allow(clippy::no_effect)]
471        [(); 1][n as usize];
472        OCFE_W::new(self, n * 0 + 2)
473    }
474    ///Bit 2 - Output compare 1 fast enable
475    #[inline(always)]
476    pub fn oc1fe(&mut self) -> OCFE_W<CCMR1_OUTPUTrs> {
477        OCFE_W::new(self, 2)
478    }
479    ///Output compare (1-1) preload enable
480    ///
481    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1PE` field.</div>
482    #[inline(always)]
483    pub fn ocpe(&mut self, n: u8) -> OCPE_W<CCMR1_OUTPUTrs> {
484        #[allow(clippy::no_effect)]
485        [(); 1][n as usize];
486        OCPE_W::new(self, n * 0 + 3)
487    }
488    ///Bit 3 - Output compare 1 preload enable
489    #[inline(always)]
490    pub fn oc1pe(&mut self) -> OCPE_W<CCMR1_OUTPUTrs> {
491        OCPE_W::new(self, 3)
492    }
493    ///Output compare (1-1) mode
494    ///
495    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1M` field.</div>
496    #[inline(always)]
497    pub fn ocm(&mut self, n: u8) -> OCM_W<CCMR1_OUTPUTrs> {
498        #[allow(clippy::no_effect)]
499        [(); 1][n as usize];
500        OCM_W::new(self, n * 0 + 4)
501    }
502    ///Bits 4:6 - Output compare 1 mode
503    #[inline(always)]
504    pub fn oc1m(&mut self) -> OCM_W<CCMR1_OUTPUTrs> {
505        OCM_W::new(self, 4)
506    }
507    ///Output compare (1-1) clear enable
508    ///
509    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1CE` field.</div>
510    #[inline(always)]
511    pub fn occe(&mut self, n: u8) -> OCCE_W<CCMR1_OUTPUTrs> {
512        #[allow(clippy::no_effect)]
513        [(); 1][n as usize];
514        OCCE_W::new(self, n * 0 + 7)
515    }
516    ///Bit 7 - Output compare 1 clear enable
517    #[inline(always)]
518    pub fn oc1ce(&mut self) -> OCCE_W<CCMR1_OUTPUTrs> {
519        OCCE_W::new(self, 7)
520    }
521    ///Output compare (1-1) mode, bit 3
522    ///
523    ///<div class="warning">`n` is number of field in register. `n == 0` corresponds to `OC1M_3` field.</div>
524    #[inline(always)]
525    pub fn ocm_3(&mut self, n: u8) -> OCM_3_W<CCMR1_OUTPUTrs> {
526        #[allow(clippy::no_effect)]
527        [(); 1][n as usize];
528        OCM_3_W::new(self, n * 0 + 16)
529    }
530    ///Bit 16 - Output compare 1 mode, bit 3
531    #[inline(always)]
532    pub fn oc1m_3(&mut self) -> OCM_3_W<CCMR1_OUTPUTrs> {
533        OCM_3_W::new(self, 16)
534    }
535}
536/**capture/compare mode register 1 (output mode)
537
538You can [`read`](crate::Reg::read) this register and get [`ccmr1_output::R`](R). You can [`reset`](crate::Reg::reset), [`write`](crate::Reg::write), [`write_with_zero`](crate::Reg::write_with_zero) this register using [`ccmr1_output::W`](W). You can also [`modify`](crate::Reg::modify) this register. See [API](https://docs.rs/svd2rust/#read--modify--write-api).
539
540See register [structure](https://stm32-rs.github.io/stm32-rs/STM32G030.html#TIM14:CCMR1_Output)*/
541pub struct CCMR1_OUTPUTrs;
542impl crate::RegisterSpec for CCMR1_OUTPUTrs {
543    type Ux = u32;
544}
545///`read()` method returns [`ccmr1_output::R`](R) reader structure
546impl crate::Readable for CCMR1_OUTPUTrs {}
547///`write(|w| ..)` method takes [`ccmr1_output::W`](W) writer structure
548impl crate::Writable for CCMR1_OUTPUTrs {
549    type Safety = crate::Unsafe;
550}
551///`reset()` method sets CCMR1_Output to value 0
552impl crate::Resettable for CCMR1_OUTPUTrs {}