esp32p4/lp_uart/
conf0_sync.rs

1#[doc = "Register `CONF0_SYNC` reader"]
2pub type R = crate::R<CONF0_SYNC_SPEC>;
3#[doc = "Register `CONF0_SYNC` writer"]
4pub type W = crate::W<CONF0_SYNC_SPEC>;
5#[doc = "Field `PARITY` reader - This register is used to configure the parity check mode."]
6pub type PARITY_R = crate::BitReader;
7#[doc = "Field `PARITY` writer - This register is used to configure the parity check mode."]
8pub type PARITY_W<'a, REG> = crate::BitWriter<'a, REG>;
9#[doc = "Field `PARITY_EN` reader - Set this bit to enable uart parity check."]
10pub type PARITY_EN_R = crate::BitReader;
11#[doc = "Field `PARITY_EN` writer - Set this bit to enable uart parity check."]
12pub type PARITY_EN_W<'a, REG> = crate::BitWriter<'a, REG>;
13#[doc = "Field `BIT_NUM` reader - This register is used to set the length of data."]
14pub type BIT_NUM_R = crate::FieldReader;
15#[doc = "Field `BIT_NUM` writer - This register is used to set the length of data."]
16pub type BIT_NUM_W<'a, REG> = crate::FieldWriter<'a, REG, 2>;
17#[doc = "Field `STOP_BIT_NUM` reader - This register is used to set the length of stop bit."]
18pub type STOP_BIT_NUM_R = crate::FieldReader;
19#[doc = "Field `STOP_BIT_NUM` writer - This register is used to set the length of stop bit."]
20pub type STOP_BIT_NUM_W<'a, REG> = crate::FieldWriter<'a, REG, 2>;
21#[doc = "Field `TXD_BRK` reader - Set this bit to enbale transmitter to send NULL when the process of sending data is done."]
22pub type TXD_BRK_R = crate::BitReader;
23#[doc = "Field `TXD_BRK` writer - Set this bit to enbale transmitter to send NULL when the process of sending data is done."]
24pub type TXD_BRK_W<'a, REG> = crate::BitWriter<'a, REG>;
25#[doc = "Field `LOOPBACK` reader - Set this bit to enable uart loopback test mode."]
26pub type LOOPBACK_R = crate::BitReader;
27#[doc = "Field `LOOPBACK` writer - Set this bit to enable uart loopback test mode."]
28pub type LOOPBACK_W<'a, REG> = crate::BitWriter<'a, REG>;
29#[doc = "Field `TX_FLOW_EN` reader - Set this bit to enable flow control function for transmitter."]
30pub type TX_FLOW_EN_R = crate::BitReader;
31#[doc = "Field `TX_FLOW_EN` writer - Set this bit to enable flow control function for transmitter."]
32pub type TX_FLOW_EN_W<'a, REG> = crate::BitWriter<'a, REG>;
33#[doc = "Field `RXD_INV` reader - Set this bit to inverse the level value of uart rxd signal."]
34pub type RXD_INV_R = crate::BitReader;
35#[doc = "Field `RXD_INV` writer - Set this bit to inverse the level value of uart rxd signal."]
36pub type RXD_INV_W<'a, REG> = crate::BitWriter<'a, REG>;
37#[doc = "Field `TXD_INV` reader - Set this bit to inverse the level value of uart txd signal."]
38pub type TXD_INV_R = crate::BitReader;
39#[doc = "Field `TXD_INV` writer - Set this bit to inverse the level value of uart txd signal."]
40pub type TXD_INV_W<'a, REG> = crate::BitWriter<'a, REG>;
41#[doc = "Field `DIS_RX_DAT_OVF` reader - Disable UART Rx data overflow detect."]
42pub type DIS_RX_DAT_OVF_R = crate::BitReader;
43#[doc = "Field `DIS_RX_DAT_OVF` writer - Disable UART Rx data overflow detect."]
44pub type DIS_RX_DAT_OVF_W<'a, REG> = crate::BitWriter<'a, REG>;
45#[doc = "Field `ERR_WR_MASK` reader - 1'h1: Receiver stops storing data into FIFO when data is wrong. 1'h0: Receiver stores the data even if the received data is wrong."]
46pub type ERR_WR_MASK_R = crate::BitReader;
47#[doc = "Field `ERR_WR_MASK` writer - 1'h1: Receiver stops storing data into FIFO when data is wrong. 1'h0: Receiver stores the data even if the received data is wrong."]
48pub type ERR_WR_MASK_W<'a, REG> = crate::BitWriter<'a, REG>;
49#[doc = "Field `MEM_CLK_EN` reader - UART memory clock gate enable signal."]
50pub type MEM_CLK_EN_R = crate::BitReader;
51#[doc = "Field `MEM_CLK_EN` writer - UART memory clock gate enable signal."]
52pub type MEM_CLK_EN_W<'a, REG> = crate::BitWriter<'a, REG>;
53#[doc = "Field `SW_RTS` reader - This register is used to configure the software rts signal which is used in software flow control."]
54pub type SW_RTS_R = crate::BitReader;
55#[doc = "Field `SW_RTS` writer - This register is used to configure the software rts signal which is used in software flow control."]
56pub type SW_RTS_W<'a, REG> = crate::BitWriter<'a, REG>;
57#[doc = "Field `RXFIFO_RST` reader - Set this bit to reset the uart receive-FIFO."]
58pub type RXFIFO_RST_R = crate::BitReader;
59#[doc = "Field `RXFIFO_RST` writer - Set this bit to reset the uart receive-FIFO."]
60pub type RXFIFO_RST_W<'a, REG> = crate::BitWriter<'a, REG>;
61#[doc = "Field `TXFIFO_RST` reader - Set this bit to reset the uart transmit-FIFO."]
62pub type TXFIFO_RST_R = crate::BitReader;
63#[doc = "Field `TXFIFO_RST` writer - Set this bit to reset the uart transmit-FIFO."]
64pub type TXFIFO_RST_W<'a, REG> = crate::BitWriter<'a, REG>;
65impl R {
66    #[doc = "Bit 0 - This register is used to configure the parity check mode."]
67    #[inline(always)]
68    pub fn parity(&self) -> PARITY_R {
69        PARITY_R::new((self.bits & 1) != 0)
70    }
71    #[doc = "Bit 1 - Set this bit to enable uart parity check."]
72    #[inline(always)]
73    pub fn parity_en(&self) -> PARITY_EN_R {
74        PARITY_EN_R::new(((self.bits >> 1) & 1) != 0)
75    }
76    #[doc = "Bits 2:3 - This register is used to set the length of data."]
77    #[inline(always)]
78    pub fn bit_num(&self) -> BIT_NUM_R {
79        BIT_NUM_R::new(((self.bits >> 2) & 3) as u8)
80    }
81    #[doc = "Bits 4:5 - This register is used to set the length of stop bit."]
82    #[inline(always)]
83    pub fn stop_bit_num(&self) -> STOP_BIT_NUM_R {
84        STOP_BIT_NUM_R::new(((self.bits >> 4) & 3) as u8)
85    }
86    #[doc = "Bit 6 - Set this bit to enbale transmitter to send NULL when the process of sending data is done."]
87    #[inline(always)]
88    pub fn txd_brk(&self) -> TXD_BRK_R {
89        TXD_BRK_R::new(((self.bits >> 6) & 1) != 0)
90    }
91    #[doc = "Bit 12 - Set this bit to enable uart loopback test mode."]
92    #[inline(always)]
93    pub fn loopback(&self) -> LOOPBACK_R {
94        LOOPBACK_R::new(((self.bits >> 12) & 1) != 0)
95    }
96    #[doc = "Bit 13 - Set this bit to enable flow control function for transmitter."]
97    #[inline(always)]
98    pub fn tx_flow_en(&self) -> TX_FLOW_EN_R {
99        TX_FLOW_EN_R::new(((self.bits >> 13) & 1) != 0)
100    }
101    #[doc = "Bit 15 - Set this bit to inverse the level value of uart rxd signal."]
102    #[inline(always)]
103    pub fn rxd_inv(&self) -> RXD_INV_R {
104        RXD_INV_R::new(((self.bits >> 15) & 1) != 0)
105    }
106    #[doc = "Bit 16 - Set this bit to inverse the level value of uart txd signal."]
107    #[inline(always)]
108    pub fn txd_inv(&self) -> TXD_INV_R {
109        TXD_INV_R::new(((self.bits >> 16) & 1) != 0)
110    }
111    #[doc = "Bit 17 - Disable UART Rx data overflow detect."]
112    #[inline(always)]
113    pub fn dis_rx_dat_ovf(&self) -> DIS_RX_DAT_OVF_R {
114        DIS_RX_DAT_OVF_R::new(((self.bits >> 17) & 1) != 0)
115    }
116    #[doc = "Bit 18 - 1'h1: Receiver stops storing data into FIFO when data is wrong. 1'h0: Receiver stores the data even if the received data is wrong."]
117    #[inline(always)]
118    pub fn err_wr_mask(&self) -> ERR_WR_MASK_R {
119        ERR_WR_MASK_R::new(((self.bits >> 18) & 1) != 0)
120    }
121    #[doc = "Bit 20 - UART memory clock gate enable signal."]
122    #[inline(always)]
123    pub fn mem_clk_en(&self) -> MEM_CLK_EN_R {
124        MEM_CLK_EN_R::new(((self.bits >> 20) & 1) != 0)
125    }
126    #[doc = "Bit 21 - This register is used to configure the software rts signal which is used in software flow control."]
127    #[inline(always)]
128    pub fn sw_rts(&self) -> SW_RTS_R {
129        SW_RTS_R::new(((self.bits >> 21) & 1) != 0)
130    }
131    #[doc = "Bit 22 - Set this bit to reset the uart receive-FIFO."]
132    #[inline(always)]
133    pub fn rxfifo_rst(&self) -> RXFIFO_RST_R {
134        RXFIFO_RST_R::new(((self.bits >> 22) & 1) != 0)
135    }
136    #[doc = "Bit 23 - Set this bit to reset the uart transmit-FIFO."]
137    #[inline(always)]
138    pub fn txfifo_rst(&self) -> TXFIFO_RST_R {
139        TXFIFO_RST_R::new(((self.bits >> 23) & 1) != 0)
140    }
141}
142#[cfg(feature = "impl-register-debug")]
143impl core::fmt::Debug for R {
144    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
145        f.debug_struct("CONF0_SYNC")
146            .field("parity", &format_args!("{}", self.parity().bit()))
147            .field("parity_en", &format_args!("{}", self.parity_en().bit()))
148            .field("bit_num", &format_args!("{}", self.bit_num().bits()))
149            .field(
150                "stop_bit_num",
151                &format_args!("{}", self.stop_bit_num().bits()),
152            )
153            .field("txd_brk", &format_args!("{}", self.txd_brk().bit()))
154            .field("loopback", &format_args!("{}", self.loopback().bit()))
155            .field("tx_flow_en", &format_args!("{}", self.tx_flow_en().bit()))
156            .field("rxd_inv", &format_args!("{}", self.rxd_inv().bit()))
157            .field("txd_inv", &format_args!("{}", self.txd_inv().bit()))
158            .field(
159                "dis_rx_dat_ovf",
160                &format_args!("{}", self.dis_rx_dat_ovf().bit()),
161            )
162            .field("err_wr_mask", &format_args!("{}", self.err_wr_mask().bit()))
163            .field("mem_clk_en", &format_args!("{}", self.mem_clk_en().bit()))
164            .field("sw_rts", &format_args!("{}", self.sw_rts().bit()))
165            .field("rxfifo_rst", &format_args!("{}", self.rxfifo_rst().bit()))
166            .field("txfifo_rst", &format_args!("{}", self.txfifo_rst().bit()))
167            .finish()
168    }
169}
170#[cfg(feature = "impl-register-debug")]
171impl core::fmt::Debug for crate::generic::Reg<CONF0_SYNC_SPEC> {
172    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
173        core::fmt::Debug::fmt(&self.read(), f)
174    }
175}
176impl W {
177    #[doc = "Bit 0 - This register is used to configure the parity check mode."]
178    #[inline(always)]
179    #[must_use]
180    pub fn parity(&mut self) -> PARITY_W<CONF0_SYNC_SPEC> {
181        PARITY_W::new(self, 0)
182    }
183    #[doc = "Bit 1 - Set this bit to enable uart parity check."]
184    #[inline(always)]
185    #[must_use]
186    pub fn parity_en(&mut self) -> PARITY_EN_W<CONF0_SYNC_SPEC> {
187        PARITY_EN_W::new(self, 1)
188    }
189    #[doc = "Bits 2:3 - This register is used to set the length of data."]
190    #[inline(always)]
191    #[must_use]
192    pub fn bit_num(&mut self) -> BIT_NUM_W<CONF0_SYNC_SPEC> {
193        BIT_NUM_W::new(self, 2)
194    }
195    #[doc = "Bits 4:5 - This register is used to set the length of stop bit."]
196    #[inline(always)]
197    #[must_use]
198    pub fn stop_bit_num(&mut self) -> STOP_BIT_NUM_W<CONF0_SYNC_SPEC> {
199        STOP_BIT_NUM_W::new(self, 4)
200    }
201    #[doc = "Bit 6 - Set this bit to enbale transmitter to send NULL when the process of sending data is done."]
202    #[inline(always)]
203    #[must_use]
204    pub fn txd_brk(&mut self) -> TXD_BRK_W<CONF0_SYNC_SPEC> {
205        TXD_BRK_W::new(self, 6)
206    }
207    #[doc = "Bit 12 - Set this bit to enable uart loopback test mode."]
208    #[inline(always)]
209    #[must_use]
210    pub fn loopback(&mut self) -> LOOPBACK_W<CONF0_SYNC_SPEC> {
211        LOOPBACK_W::new(self, 12)
212    }
213    #[doc = "Bit 13 - Set this bit to enable flow control function for transmitter."]
214    #[inline(always)]
215    #[must_use]
216    pub fn tx_flow_en(&mut self) -> TX_FLOW_EN_W<CONF0_SYNC_SPEC> {
217        TX_FLOW_EN_W::new(self, 13)
218    }
219    #[doc = "Bit 15 - Set this bit to inverse the level value of uart rxd signal."]
220    #[inline(always)]
221    #[must_use]
222    pub fn rxd_inv(&mut self) -> RXD_INV_W<CONF0_SYNC_SPEC> {
223        RXD_INV_W::new(self, 15)
224    }
225    #[doc = "Bit 16 - Set this bit to inverse the level value of uart txd signal."]
226    #[inline(always)]
227    #[must_use]
228    pub fn txd_inv(&mut self) -> TXD_INV_W<CONF0_SYNC_SPEC> {
229        TXD_INV_W::new(self, 16)
230    }
231    #[doc = "Bit 17 - Disable UART Rx data overflow detect."]
232    #[inline(always)]
233    #[must_use]
234    pub fn dis_rx_dat_ovf(&mut self) -> DIS_RX_DAT_OVF_W<CONF0_SYNC_SPEC> {
235        DIS_RX_DAT_OVF_W::new(self, 17)
236    }
237    #[doc = "Bit 18 - 1'h1: Receiver stops storing data into FIFO when data is wrong. 1'h0: Receiver stores the data even if the received data is wrong."]
238    #[inline(always)]
239    #[must_use]
240    pub fn err_wr_mask(&mut self) -> ERR_WR_MASK_W<CONF0_SYNC_SPEC> {
241        ERR_WR_MASK_W::new(self, 18)
242    }
243    #[doc = "Bit 20 - UART memory clock gate enable signal."]
244    #[inline(always)]
245    #[must_use]
246    pub fn mem_clk_en(&mut self) -> MEM_CLK_EN_W<CONF0_SYNC_SPEC> {
247        MEM_CLK_EN_W::new(self, 20)
248    }
249    #[doc = "Bit 21 - This register is used to configure the software rts signal which is used in software flow control."]
250    #[inline(always)]
251    #[must_use]
252    pub fn sw_rts(&mut self) -> SW_RTS_W<CONF0_SYNC_SPEC> {
253        SW_RTS_W::new(self, 21)
254    }
255    #[doc = "Bit 22 - Set this bit to reset the uart receive-FIFO."]
256    #[inline(always)]
257    #[must_use]
258    pub fn rxfifo_rst(&mut self) -> RXFIFO_RST_W<CONF0_SYNC_SPEC> {
259        RXFIFO_RST_W::new(self, 22)
260    }
261    #[doc = "Bit 23 - Set this bit to reset the uart transmit-FIFO."]
262    #[inline(always)]
263    #[must_use]
264    pub fn txfifo_rst(&mut self) -> TXFIFO_RST_W<CONF0_SYNC_SPEC> {
265        TXFIFO_RST_W::new(self, 23)
266    }
267}
268#[doc = "Configuration register 0\n\nYou can [`read`](crate::generic::Reg::read) this register and get [`conf0_sync::R`](R).  You can [`reset`](crate::generic::Reg::reset), [`write`](crate::generic::Reg::write), [`write_with_zero`](crate::generic::Reg::write_with_zero) this register using [`conf0_sync::W`](W). You can also [`modify`](crate::generic::Reg::modify) this register. See [API](https://docs.rs/svd2rust/#read--modify--write-api)."]
269pub struct CONF0_SYNC_SPEC;
270impl crate::RegisterSpec for CONF0_SYNC_SPEC {
271    type Ux = u32;
272}
273#[doc = "`read()` method returns [`conf0_sync::R`](R) reader structure"]
274impl crate::Readable for CONF0_SYNC_SPEC {}
275#[doc = "`write(|w| ..)` method takes [`conf0_sync::W`](W) writer structure"]
276impl crate::Writable for CONF0_SYNC_SPEC {
277    type Safety = crate::Unsafe;
278    const ZERO_TO_MODIFY_FIELDS_BITMAP: u32 = 0;
279    const ONE_TO_MODIFY_FIELDS_BITMAP: u32 = 0;
280}
281#[doc = "`reset()` method sets CONF0_SYNC to value 0x1c"]
282impl crate::Resettable for CONF0_SYNC_SPEC {
283    const RESET_VALUE: u32 = 0x1c;
284}
esp32p4/lp_uart/conf0_sync.rs

esp32p4/lp_uart/
conf0_sync.rs
