esp32s3 0.16.0

Peripheral access crate for the ESP32-S3
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

#[doc = "Register `SAR_TOUCH_CONF` reader"]
pub struct R(crate::R<SAR_TOUCH_CONF_SPEC>);
impl core::ops::Deref for R {
    type Target = crate::R<SAR_TOUCH_CONF_SPEC>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl From<crate::R<SAR_TOUCH_CONF_SPEC>> for R {
    #[inline(always)]
    fn from(reader: crate::R<SAR_TOUCH_CONF_SPEC>) -> Self {
        R(reader)
    }
}
#[doc = "Register `SAR_TOUCH_CONF` writer"]
pub struct W(crate::W<SAR_TOUCH_CONF_SPEC>);
impl core::ops::Deref for W {
    type Target = crate::W<SAR_TOUCH_CONF_SPEC>;
    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl core::ops::DerefMut for W {
    #[inline(always)]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}
impl From<crate::W<SAR_TOUCH_CONF_SPEC>> for W {
    #[inline(always)]
    fn from(writer: crate::W<SAR_TOUCH_CONF_SPEC>) -> Self {
        W(writer)
    }
}
#[doc = "Field `SAR_TOUCH_OUTEN` reader - touch controller output enable"]
pub type SAR_TOUCH_OUTEN_R = crate::FieldReader<u16, u16>;
#[doc = "Field `SAR_TOUCH_OUTEN` writer - touch controller output enable"]
pub type SAR_TOUCH_OUTEN_W<'a, const O: u8> =
    crate::FieldWriter<'a, u32, SAR_TOUCH_CONF_SPEC, u16, u16, 15, O>;
#[doc = "Field `SAR_TOUCH_STATUS_CLR` writer - clear all touch active status"]
pub type SAR_TOUCH_STATUS_CLR_W<'a, const O: u8> =
    crate::BitWriter<'a, u32, SAR_TOUCH_CONF_SPEC, bool, O>;
#[doc = "Field `SAR_TOUCH_DATA_SEL` reader - 3: smooth data 2: baseline 1,0: raw_data"]
pub type SAR_TOUCH_DATA_SEL_R = crate::FieldReader<u8, u8>;
#[doc = "Field `SAR_TOUCH_DATA_SEL` writer - 3: smooth data 2: baseline 1,0: raw_data"]
pub type SAR_TOUCH_DATA_SEL_W<'a, const O: u8> =
    crate::FieldWriter<'a, u32, SAR_TOUCH_CONF_SPEC, u8, u8, 2, O>;
#[doc = "Field `SAR_TOUCH_DENOISE_END` reader - touch_denoise_done"]
pub type SAR_TOUCH_DENOISE_END_R = crate::BitReader<bool>;
#[doc = "Field `SAR_TOUCH_UNIT_END` reader - touch_unit_done"]
pub type SAR_TOUCH_UNIT_END_R = crate::BitReader<bool>;
#[doc = "Field `SAR_TOUCH_APPROACH_PAD2` reader - indicate which pad is approach pad2"]
pub type SAR_TOUCH_APPROACH_PAD2_R = crate::FieldReader<u8, u8>;
#[doc = "Field `SAR_TOUCH_APPROACH_PAD2` writer - indicate which pad is approach pad2"]
pub type SAR_TOUCH_APPROACH_PAD2_W<'a, const O: u8> =
    crate::FieldWriter<'a, u32, SAR_TOUCH_CONF_SPEC, u8, u8, 4, O>;
#[doc = "Field `SAR_TOUCH_APPROACH_PAD1` reader - indicate which pad is approach pad1"]
pub type SAR_TOUCH_APPROACH_PAD1_R = crate::FieldReader<u8, u8>;
#[doc = "Field `SAR_TOUCH_APPROACH_PAD1` writer - indicate which pad is approach pad1"]
pub type SAR_TOUCH_APPROACH_PAD1_W<'a, const O: u8> =
    crate::FieldWriter<'a, u32, SAR_TOUCH_CONF_SPEC, u8, u8, 4, O>;
#[doc = "Field `SAR_TOUCH_APPROACH_PAD0` reader - indicate which pad is approach pad0"]
pub type SAR_TOUCH_APPROACH_PAD0_R = crate::FieldReader<u8, u8>;
#[doc = "Field `SAR_TOUCH_APPROACH_PAD0` writer - indicate which pad is approach pad0"]
pub type SAR_TOUCH_APPROACH_PAD0_W<'a, const O: u8> =
    crate::FieldWriter<'a, u32, SAR_TOUCH_CONF_SPEC, u8, u8, 4, O>;
impl R {
    #[doc = "Bits 0:14 - touch controller output enable"]
    #[inline(always)]
    pub fn sar_touch_outen(&self) -> SAR_TOUCH_OUTEN_R {
        SAR_TOUCH_OUTEN_R::new((self.bits & 0x7fff) as u16)
    }
    #[doc = "Bits 16:17 - 3: smooth data 2: baseline 1,0: raw_data"]
    #[inline(always)]
    pub fn sar_touch_data_sel(&self) -> SAR_TOUCH_DATA_SEL_R {
        SAR_TOUCH_DATA_SEL_R::new(((self.bits >> 16) & 3) as u8)
    }
    #[doc = "Bit 18 - touch_denoise_done"]
    #[inline(always)]
    pub fn sar_touch_denoise_end(&self) -> SAR_TOUCH_DENOISE_END_R {
        SAR_TOUCH_DENOISE_END_R::new(((self.bits >> 18) & 1) != 0)
    }
    #[doc = "Bit 19 - touch_unit_done"]
    #[inline(always)]
    pub fn sar_touch_unit_end(&self) -> SAR_TOUCH_UNIT_END_R {
        SAR_TOUCH_UNIT_END_R::new(((self.bits >> 19) & 1) != 0)
    }
    #[doc = "Bits 20:23 - indicate which pad is approach pad2"]
    #[inline(always)]
    pub fn sar_touch_approach_pad2(&self) -> SAR_TOUCH_APPROACH_PAD2_R {
        SAR_TOUCH_APPROACH_PAD2_R::new(((self.bits >> 20) & 0x0f) as u8)
    }
    #[doc = "Bits 24:27 - indicate which pad is approach pad1"]
    #[inline(always)]
    pub fn sar_touch_approach_pad1(&self) -> SAR_TOUCH_APPROACH_PAD1_R {
        SAR_TOUCH_APPROACH_PAD1_R::new(((self.bits >> 24) & 0x0f) as u8)
    }
    #[doc = "Bits 28:31 - indicate which pad is approach pad0"]
    #[inline(always)]
    pub fn sar_touch_approach_pad0(&self) -> SAR_TOUCH_APPROACH_PAD0_R {
        SAR_TOUCH_APPROACH_PAD0_R::new(((self.bits >> 28) & 0x0f) as u8)
    }
}
impl W {
    #[doc = "Bits 0:14 - touch controller output enable"]
    #[inline(always)]
    #[must_use]
    pub fn sar_touch_outen(&mut self) -> SAR_TOUCH_OUTEN_W<0> {
        SAR_TOUCH_OUTEN_W::new(self)
    }
    #[doc = "Bit 15 - clear all touch active status"]
    #[inline(always)]
    #[must_use]
    pub fn sar_touch_status_clr(&mut self) -> SAR_TOUCH_STATUS_CLR_W<15> {
        SAR_TOUCH_STATUS_CLR_W::new(self)
    }
    #[doc = "Bits 16:17 - 3: smooth data 2: baseline 1,0: raw_data"]
    #[inline(always)]
    #[must_use]
    pub fn sar_touch_data_sel(&mut self) -> SAR_TOUCH_DATA_SEL_W<16> {
        SAR_TOUCH_DATA_SEL_W::new(self)
    }
    #[doc = "Bits 20:23 - indicate which pad is approach pad2"]
    #[inline(always)]
    #[must_use]
    pub fn sar_touch_approach_pad2(&mut self) -> SAR_TOUCH_APPROACH_PAD2_W<20> {
        SAR_TOUCH_APPROACH_PAD2_W::new(self)
    }
    #[doc = "Bits 24:27 - indicate which pad is approach pad1"]
    #[inline(always)]
    #[must_use]
    pub fn sar_touch_approach_pad1(&mut self) -> SAR_TOUCH_APPROACH_PAD1_W<24> {
        SAR_TOUCH_APPROACH_PAD1_W::new(self)
    }
    #[doc = "Bits 28:31 - indicate which pad is approach pad0"]
    #[inline(always)]
    #[must_use]
    pub fn sar_touch_approach_pad0(&mut self) -> SAR_TOUCH_APPROACH_PAD0_W<28> {
        SAR_TOUCH_APPROACH_PAD0_W::new(self)
    }
    #[doc = "Writes raw bits to the register."]
    #[inline(always)]
    pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
        self.0.bits(bits);
        self
    }
}
#[doc = "configure touch controller\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 [sar_touch_conf](index.html) module"]
pub struct SAR_TOUCH_CONF_SPEC;
impl crate::RegisterSpec for SAR_TOUCH_CONF_SPEC {
    type Ux = u32;
}
#[doc = "`read()` method returns [sar_touch_conf::R](R) reader structure"]
impl crate::Readable for SAR_TOUCH_CONF_SPEC {
    type Reader = R;
}
#[doc = "`write(|w| ..)` method takes [sar_touch_conf::W](W) writer structure"]
impl crate::Writable for SAR_TOUCH_CONF_SPEC {
    type Writer = W;
    const ZERO_TO_MODIFY_FIELDS_BITMAP: Self::Ux = 0;
    const ONE_TO_MODIFY_FIELDS_BITMAP: Self::Ux = 0;
}
#[doc = "`reset()` method sets SAR_TOUCH_CONF to value 0xfff0_7fff"]
impl crate::Resettable for SAR_TOUCH_CONF_SPEC {
    const RESET_VALUE: Self::Ux = 0xfff0_7fff;
}