nrf52840_pac/i2s/config/
ratio.rs

Help
1#[doc = "Register `RATIO` reader"]
2pub struct R(crate::R<RATIO_SPEC>);
3impl core::ops::Deref for R {
4    type Target = crate::R<RATIO_SPEC>;
5    #[inline(always)]
6    fn deref(&self) -> &Self::Target {
7        &self.0
8    }
9}
10impl From<crate::R<RATIO_SPEC>> for R {
11    #[inline(always)]
12    fn from(reader: crate::R<RATIO_SPEC>) -> Self {
13        R(reader)
14    }
15}
16#[doc = "Register `RATIO` writer"]
17pub struct W(crate::W<RATIO_SPEC>);
18impl core::ops::Deref for W {
19    type Target = crate::W<RATIO_SPEC>;
20    #[inline(always)]
21    fn deref(&self) -> &Self::Target {
22        &self.0
23    }
24}
25impl core::ops::DerefMut for W {
26    #[inline(always)]
27    fn deref_mut(&mut self) -> &mut Self::Target {
28        &mut self.0
29    }
30}
31impl From<crate::W<RATIO_SPEC>> for W {
32    #[inline(always)]
33    fn from(writer: crate::W<RATIO_SPEC>) -> Self {
34        W(writer)
35    }
36}
37#[doc = "Field `RATIO` reader - MCK / LRCK ratio."]
38pub type RATIO_R = crate::FieldReader<u8, RATIO_A>;
39#[doc = "MCK / LRCK ratio.\n\nValue on reset: 6"]
40#[derive(Clone, Copy, Debug, PartialEq)]
41#[repr(u8)]
42pub enum RATIO_A {
43    #[doc = "0: LRCK = MCK / 32"]
44    _32X = 0,
45    #[doc = "1: LRCK = MCK / 48"]
46    _48X = 1,
47    #[doc = "2: LRCK = MCK / 64"]
48    _64X = 2,
49    #[doc = "3: LRCK = MCK / 96"]
50    _96X = 3,
51    #[doc = "4: LRCK = MCK / 128"]
52    _128X = 4,
53    #[doc = "5: LRCK = MCK / 192"]
54    _192X = 5,
55    #[doc = "6: LRCK = MCK / 256"]
56    _256X = 6,
57    #[doc = "7: LRCK = MCK / 384"]
58    _384X = 7,
59    #[doc = "8: LRCK = MCK / 512"]
60    _512X = 8,
61}
62impl From<RATIO_A> for u8 {
63    #[inline(always)]
64    fn from(variant: RATIO_A) -> Self {
65        variant as _
66    }
67}
68impl RATIO_R {
69    #[doc = "Get enumerated values variant"]
70    #[inline(always)]
71    pub fn variant(&self) -> Option<RATIO_A> {
72        match self.bits {
73            0 => Some(RATIO_A::_32X),
74            1 => Some(RATIO_A::_48X),
75            2 => Some(RATIO_A::_64X),
76            3 => Some(RATIO_A::_96X),
77            4 => Some(RATIO_A::_128X),
78            5 => Some(RATIO_A::_192X),
79            6 => Some(RATIO_A::_256X),
80            7 => Some(RATIO_A::_384X),
81            8 => Some(RATIO_A::_512X),
82            _ => None,
83        }
84    }
85    #[doc = "Checks if the value of the field is `_32X`"]
86    #[inline(always)]
87    pub fn is_32x(&self) -> bool {
88        *self == RATIO_A::_32X
89    }
90    #[doc = "Checks if the value of the field is `_48X`"]
91    #[inline(always)]
92    pub fn is_48x(&self) -> bool {
93        *self == RATIO_A::_48X
94    }
95    #[doc = "Checks if the value of the field is `_64X`"]
96    #[inline(always)]
97    pub fn is_64x(&self) -> bool {
98        *self == RATIO_A::_64X
99    }
100    #[doc = "Checks if the value of the field is `_96X`"]
101    #[inline(always)]
102    pub fn is_96x(&self) -> bool {
103        *self == RATIO_A::_96X
104    }
105    #[doc = "Checks if the value of the field is `_128X`"]
106    #[inline(always)]
107    pub fn is_128x(&self) -> bool {
108        *self == RATIO_A::_128X
109    }
110    #[doc = "Checks if the value of the field is `_192X`"]
111    #[inline(always)]
112    pub fn is_192x(&self) -> bool {
113        *self == RATIO_A::_192X
114    }
115    #[doc = "Checks if the value of the field is `_256X`"]
116    #[inline(always)]
117    pub fn is_256x(&self) -> bool {
118        *self == RATIO_A::_256X
119    }
120    #[doc = "Checks if the value of the field is `_384X`"]
121    #[inline(always)]
122    pub fn is_384x(&self) -> bool {
123        *self == RATIO_A::_384X
124    }
125    #[doc = "Checks if the value of the field is `_512X`"]
126    #[inline(always)]
127    pub fn is_512x(&self) -> bool {
128        *self == RATIO_A::_512X
129    }
130}
131#[doc = "Field `RATIO` writer - MCK / LRCK ratio."]
132pub type RATIO_W<'a, const O: u8> = crate::FieldWriter<'a, u32, RATIO_SPEC, u8, RATIO_A, 4, O>;
133impl<'a, const O: u8> RATIO_W<'a, O> {
134    #[doc = "LRCK = MCK / 32"]
135    #[inline(always)]
136    pub fn _32x(self) -> &'a mut W {
137        self.variant(RATIO_A::_32X)
138    }
139    #[doc = "LRCK = MCK / 48"]
140    #[inline(always)]
141    pub fn _48x(self) -> &'a mut W {
142        self.variant(RATIO_A::_48X)
143    }
144    #[doc = "LRCK = MCK / 64"]
145    #[inline(always)]
146    pub fn _64x(self) -> &'a mut W {
147        self.variant(RATIO_A::_64X)
148    }
149    #[doc = "LRCK = MCK / 96"]
150    #[inline(always)]
151    pub fn _96x(self) -> &'a mut W {
152        self.variant(RATIO_A::_96X)
153    }
154    #[doc = "LRCK = MCK / 128"]
155    #[inline(always)]
156    pub fn _128x(self) -> &'a mut W {
157        self.variant(RATIO_A::_128X)
158    }
159    #[doc = "LRCK = MCK / 192"]
160    #[inline(always)]
161    pub fn _192x(self) -> &'a mut W {
162        self.variant(RATIO_A::_192X)
163    }
164    #[doc = "LRCK = MCK / 256"]
165    #[inline(always)]
166    pub fn _256x(self) -> &'a mut W {
167        self.variant(RATIO_A::_256X)
168    }
169    #[doc = "LRCK = MCK / 384"]
170    #[inline(always)]
171    pub fn _384x(self) -> &'a mut W {
172        self.variant(RATIO_A::_384X)
173    }
174    #[doc = "LRCK = MCK / 512"]
175    #[inline(always)]
176    pub fn _512x(self) -> &'a mut W {
177        self.variant(RATIO_A::_512X)
178    }
179}
180impl R {
181    #[doc = "Bits 0:3 - MCK / LRCK ratio."]
182    #[inline(always)]
183    pub fn ratio(&self) -> RATIO_R {
184        RATIO_R::new((self.bits & 0x0f) as u8)
185    }
186}
187impl W {
188    #[doc = "Bits 0:3 - MCK / LRCK ratio."]
189    #[inline(always)]
190    pub fn ratio(&mut self) -> RATIO_W<0> {
191        RATIO_W::new(self)
192    }
193    #[doc = "Writes raw bits to the register."]
194    #[inline(always)]
195    pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
196        self.0.bits(bits);
197        self
198    }
199}
200#[doc = "MCK / LRCK ratio.\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 [ratio](index.html) module"]
201pub struct RATIO_SPEC;
202impl crate::RegisterSpec for RATIO_SPEC {
203    type Ux = u32;
204}
205#[doc = "`read()` method returns [ratio::R](R) reader structure"]
206impl crate::Readable for RATIO_SPEC {
207    type Reader = R;
208}
209#[doc = "`write(|w| ..)` method takes [ratio::W](W) writer structure"]
210impl crate::Writable for RATIO_SPEC {
211    type Writer = W;
212}
213#[doc = "`reset()` method sets RATIO to value 0x06"]
214impl crate::Resettable for RATIO_SPEC {
215    #[inline(always)]
216    fn reset_value() -> Self::Ux {
217        0x06
218    }
219}
nrf52840_pac/i2s/config/ratio.rs

nrf52840_pac/i2s/config/
ratio.rs
