nrf52840_pac/saadc/
oversample.rs

Help
1#[doc = "Register `OVERSAMPLE` reader"]
2pub struct R(crate::R<OVERSAMPLE_SPEC>);
3impl core::ops::Deref for R {
4    type Target = crate::R<OVERSAMPLE_SPEC>;
5    #[inline(always)]
6    fn deref(&self) -> &Self::Target {
7        &self.0
8    }
9}
10impl From<crate::R<OVERSAMPLE_SPEC>> for R {
11    #[inline(always)]
12    fn from(reader: crate::R<OVERSAMPLE_SPEC>) -> Self {
13        R(reader)
14    }
15}
16#[doc = "Register `OVERSAMPLE` writer"]
17pub struct W(crate::W<OVERSAMPLE_SPEC>);
18impl core::ops::Deref for W {
19    type Target = crate::W<OVERSAMPLE_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<OVERSAMPLE_SPEC>> for W {
32    #[inline(always)]
33    fn from(writer: crate::W<OVERSAMPLE_SPEC>) -> Self {
34        W(writer)
35    }
36}
37#[doc = "Field `OVERSAMPLE` reader - Oversample control"]
38pub type OVERSAMPLE_R = crate::FieldReader<u8, OVERSAMPLE_A>;
39#[doc = "Oversample control\n\nValue on reset: 0"]
40#[derive(Clone, Copy, Debug, PartialEq)]
41#[repr(u8)]
42pub enum OVERSAMPLE_A {
43    #[doc = "0: Bypass oversampling"]
44    BYPASS = 0,
45    #[doc = "1: Oversample 2x"]
46    OVER2X = 1,
47    #[doc = "2: Oversample 4x"]
48    OVER4X = 2,
49    #[doc = "3: Oversample 8x"]
50    OVER8X = 3,
51    #[doc = "4: Oversample 16x"]
52    OVER16X = 4,
53    #[doc = "5: Oversample 32x"]
54    OVER32X = 5,
55    #[doc = "6: Oversample 64x"]
56    OVER64X = 6,
57    #[doc = "7: Oversample 128x"]
58    OVER128X = 7,
59    #[doc = "8: Oversample 256x"]
60    OVER256X = 8,
61}
62impl From<OVERSAMPLE_A> for u8 {
63    #[inline(always)]
64    fn from(variant: OVERSAMPLE_A) -> Self {
65        variant as _
66    }
67}
68impl OVERSAMPLE_R {
69    #[doc = "Get enumerated values variant"]
70    #[inline(always)]
71    pub fn variant(&self) -> Option<OVERSAMPLE_A> {
72        match self.bits {
73            0 => Some(OVERSAMPLE_A::BYPASS),
74            1 => Some(OVERSAMPLE_A::OVER2X),
75            2 => Some(OVERSAMPLE_A::OVER4X),
76            3 => Some(OVERSAMPLE_A::OVER8X),
77            4 => Some(OVERSAMPLE_A::OVER16X),
78            5 => Some(OVERSAMPLE_A::OVER32X),
79            6 => Some(OVERSAMPLE_A::OVER64X),
80            7 => Some(OVERSAMPLE_A::OVER128X),
81            8 => Some(OVERSAMPLE_A::OVER256X),
82            _ => None,
83        }
84    }
85    #[doc = "Checks if the value of the field is `BYPASS`"]
86    #[inline(always)]
87    pub fn is_bypass(&self) -> bool {
88        *self == OVERSAMPLE_A::BYPASS
89    }
90    #[doc = "Checks if the value of the field is `OVER2X`"]
91    #[inline(always)]
92    pub fn is_over2x(&self) -> bool {
93        *self == OVERSAMPLE_A::OVER2X
94    }
95    #[doc = "Checks if the value of the field is `OVER4X`"]
96    #[inline(always)]
97    pub fn is_over4x(&self) -> bool {
98        *self == OVERSAMPLE_A::OVER4X
99    }
100    #[doc = "Checks if the value of the field is `OVER8X`"]
101    #[inline(always)]
102    pub fn is_over8x(&self) -> bool {
103        *self == OVERSAMPLE_A::OVER8X
104    }
105    #[doc = "Checks if the value of the field is `OVER16X`"]
106    #[inline(always)]
107    pub fn is_over16x(&self) -> bool {
108        *self == OVERSAMPLE_A::OVER16X
109    }
110    #[doc = "Checks if the value of the field is `OVER32X`"]
111    #[inline(always)]
112    pub fn is_over32x(&self) -> bool {
113        *self == OVERSAMPLE_A::OVER32X
114    }
115    #[doc = "Checks if the value of the field is `OVER64X`"]
116    #[inline(always)]
117    pub fn is_over64x(&self) -> bool {
118        *self == OVERSAMPLE_A::OVER64X
119    }
120    #[doc = "Checks if the value of the field is `OVER128X`"]
121    #[inline(always)]
122    pub fn is_over128x(&self) -> bool {
123        *self == OVERSAMPLE_A::OVER128X
124    }
125    #[doc = "Checks if the value of the field is `OVER256X`"]
126    #[inline(always)]
127    pub fn is_over256x(&self) -> bool {
128        *self == OVERSAMPLE_A::OVER256X
129    }
130}
131#[doc = "Field `OVERSAMPLE` writer - Oversample control"]
132pub type OVERSAMPLE_W<'a, const O: u8> =
133    crate::FieldWriter<'a, u32, OVERSAMPLE_SPEC, u8, OVERSAMPLE_A, 4, O>;
134impl<'a, const O: u8> OVERSAMPLE_W<'a, O> {
135    #[doc = "Bypass oversampling"]
136    #[inline(always)]
137    pub fn bypass(self) -> &'a mut W {
138        self.variant(OVERSAMPLE_A::BYPASS)
139    }
140    #[doc = "Oversample 2x"]
141    #[inline(always)]
142    pub fn over2x(self) -> &'a mut W {
143        self.variant(OVERSAMPLE_A::OVER2X)
144    }
145    #[doc = "Oversample 4x"]
146    #[inline(always)]
147    pub fn over4x(self) -> &'a mut W {
148        self.variant(OVERSAMPLE_A::OVER4X)
149    }
150    #[doc = "Oversample 8x"]
151    #[inline(always)]
152    pub fn over8x(self) -> &'a mut W {
153        self.variant(OVERSAMPLE_A::OVER8X)
154    }
155    #[doc = "Oversample 16x"]
156    #[inline(always)]
157    pub fn over16x(self) -> &'a mut W {
158        self.variant(OVERSAMPLE_A::OVER16X)
159    }
160    #[doc = "Oversample 32x"]
161    #[inline(always)]
162    pub fn over32x(self) -> &'a mut W {
163        self.variant(OVERSAMPLE_A::OVER32X)
164    }
165    #[doc = "Oversample 64x"]
166    #[inline(always)]
167    pub fn over64x(self) -> &'a mut W {
168        self.variant(OVERSAMPLE_A::OVER64X)
169    }
170    #[doc = "Oversample 128x"]
171    #[inline(always)]
172    pub fn over128x(self) -> &'a mut W {
173        self.variant(OVERSAMPLE_A::OVER128X)
174    }
175    #[doc = "Oversample 256x"]
176    #[inline(always)]
177    pub fn over256x(self) -> &'a mut W {
178        self.variant(OVERSAMPLE_A::OVER256X)
179    }
180}
181impl R {
182    #[doc = "Bits 0:3 - Oversample control"]
183    #[inline(always)]
184    pub fn oversample(&self) -> OVERSAMPLE_R {
185        OVERSAMPLE_R::new((self.bits & 0x0f) as u8)
186    }
187}
188impl W {
189    #[doc = "Bits 0:3 - Oversample control"]
190    #[inline(always)]
191    pub fn oversample(&mut self) -> OVERSAMPLE_W<0> {
192        OVERSAMPLE_W::new(self)
193    }
194    #[doc = "Writes raw bits to the register."]
195    #[inline(always)]
196    pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
197        self.0.bits(bits);
198        self
199    }
200}
201#[doc = "Oversampling configuration. The RESOLUTION is applied before averaging, thus for high OVERSAMPLE a higher RESOLUTION should be used.\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 [oversample](index.html) module"]
202pub struct OVERSAMPLE_SPEC;
203impl crate::RegisterSpec for OVERSAMPLE_SPEC {
204    type Ux = u32;
205}
206#[doc = "`read()` method returns [oversample::R](R) reader structure"]
207impl crate::Readable for OVERSAMPLE_SPEC {
208    type Reader = R;
209}
210#[doc = "`write(|w| ..)` method takes [oversample::W](W) writer structure"]
211impl crate::Writable for OVERSAMPLE_SPEC {
212    type Writer = W;
213}
214#[doc = "`reset()` method sets OVERSAMPLE to value 0"]
215impl crate::Resettable for OVERSAMPLE_SPEC {
216    #[inline(always)]
217    fn reset_value() -> Self::Ux {
218        0
219    }
220}
nrf52840_pac/saadc/oversample.rs

nrf52840_pac/saadc/
oversample.rs
