nrf52840_pac/i2s/config/
format.rs

Help
1#[doc = "Register `FORMAT` reader"]
2pub struct R(crate::R<FORMAT_SPEC>);
3impl core::ops::Deref for R {
4    type Target = crate::R<FORMAT_SPEC>;
5    #[inline(always)]
6    fn deref(&self) -> &Self::Target {
7        &self.0
8    }
9}
10impl From<crate::R<FORMAT_SPEC>> for R {
11    #[inline(always)]
12    fn from(reader: crate::R<FORMAT_SPEC>) -> Self {
13        R(reader)
14    }
15}
16#[doc = "Register `FORMAT` writer"]
17pub struct W(crate::W<FORMAT_SPEC>);
18impl core::ops::Deref for W {
19    type Target = crate::W<FORMAT_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<FORMAT_SPEC>> for W {
32    #[inline(always)]
33    fn from(writer: crate::W<FORMAT_SPEC>) -> Self {
34        W(writer)
35    }
36}
37#[doc = "Field `FORMAT` reader - Frame format."]
38pub type FORMAT_R = crate::BitReader<FORMAT_A>;
39#[doc = "Frame format.\n\nValue on reset: 0"]
40#[derive(Clone, Copy, Debug, PartialEq)]
41pub enum FORMAT_A {
42    #[doc = "0: Original I2S format."]
43    I2S = 0,
44    #[doc = "1: Alternate (left- or right-aligned) format."]
45    ALIGNED = 1,
46}
47impl From<FORMAT_A> for bool {
48    #[inline(always)]
49    fn from(variant: FORMAT_A) -> Self {
50        variant as u8 != 0
51    }
52}
53impl FORMAT_R {
54    #[doc = "Get enumerated values variant"]
55    #[inline(always)]
56    pub fn variant(&self) -> FORMAT_A {
57        match self.bits {
58            false => FORMAT_A::I2S,
59            true => FORMAT_A::ALIGNED,
60        }
61    }
62    #[doc = "Checks if the value of the field is `I2S`"]
63    #[inline(always)]
64    pub fn is_i2s(&self) -> bool {
65        *self == FORMAT_A::I2S
66    }
67    #[doc = "Checks if the value of the field is `ALIGNED`"]
68    #[inline(always)]
69    pub fn is_aligned(&self) -> bool {
70        *self == FORMAT_A::ALIGNED
71    }
72}
73#[doc = "Field `FORMAT` writer - Frame format."]
74pub type FORMAT_W<'a, const O: u8> = crate::BitWriter<'a, u32, FORMAT_SPEC, FORMAT_A, O>;
75impl<'a, const O: u8> FORMAT_W<'a, O> {
76    #[doc = "Original I2S format."]
77    #[inline(always)]
78    pub fn i2s(self) -> &'a mut W {
79        self.variant(FORMAT_A::I2S)
80    }
81    #[doc = "Alternate (left- or right-aligned) format."]
82    #[inline(always)]
83    pub fn aligned(self) -> &'a mut W {
84        self.variant(FORMAT_A::ALIGNED)
85    }
86}
87impl R {
88    #[doc = "Bit 0 - Frame format."]
89    #[inline(always)]
90    pub fn format(&self) -> FORMAT_R {
91        FORMAT_R::new((self.bits & 1) != 0)
92    }
93}
94impl W {
95    #[doc = "Bit 0 - Frame format."]
96    #[inline(always)]
97    pub fn format(&mut self) -> FORMAT_W<0> {
98        FORMAT_W::new(self)
99    }
100    #[doc = "Writes raw bits to the register."]
101    #[inline(always)]
102    pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
103        self.0.bits(bits);
104        self
105    }
106}
107#[doc = "Frame format.\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 [format](index.html) module"]
108pub struct FORMAT_SPEC;
109impl crate::RegisterSpec for FORMAT_SPEC {
110    type Ux = u32;
111}
112#[doc = "`read()` method returns [format::R](R) reader structure"]
113impl crate::Readable for FORMAT_SPEC {
114    type Reader = R;
115}
116#[doc = "`write(|w| ..)` method takes [format::W](W) writer structure"]
117impl crate::Writable for FORMAT_SPEC {
118    type Writer = W;
119}
120#[doc = "`reset()` method sets FORMAT to value 0"]
121impl crate::Resettable for FORMAT_SPEC {
122    #[inline(always)]
123    fn reset_value() -> Self::Ux {
124        0
125    }
126}
nrf52840_pac/i2s/config/format.rs

nrf52840_pac/i2s/config/
format.rs
