esp-hal 1.1.0-rc.0

Bare-metal HAL for Espressif devices
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

//! # GPIO configuration module (ESP32-C3)
//!
//! ## Overview
//!
//! The `GPIO` module provides functions and configurations for controlling the
//! `General Purpose Input/Output` pins on the `ESP32-C3` chip. It allows you to
//! configure pins as inputs or outputs, set their state and read their state.
//!
//! Let's get through the functionality and configurations provided by this GPIO
//! module:
//!   - `gpio` block:
//!       * Defines the pin configurations for various GPIO pins. Each line represents a pin and its
//!         associated options such as input/output mode, analog capability, and corresponding
//!         functions.
//!   - `analog` block:
//!       * Block defines the analog capabilities of various GPIO pins. Each line represents a pin
//!         and its associated options such as mux selection, function selection, and input enable.
//!   - `enum InputSignal`:
//!       * This enumeration defines input signals for the GPIO mux. Each input signal is assigned a
//!         specific value.
//!   - `enum OutputSignal`:
//!       * This enumeration defines output signals for the GPIO mux. Each output signal is assigned
//!         a specific value.
//!
//! This trait provides functions to read the interrupt status and NMI status
//! registers for both the `PRO CPU` and `APP CPU`. The implementation uses the
//! `gpio` peripheral to access the appropriate registers.

macro_rules! rtc_pins {
    ( $( $pin_num:expr )+ ) => {
        $(
            paste::paste! {
                #[cfg_attr(docsrs, doc(cfg(feature = "unstable")))]
                impl $crate::gpio::RtcPin for $crate::peripherals::[<GPIO $pin_num>]<'_> {
                    unsafe fn apply_wakeup(&self, wakeup: bool, level: u8) {
                        let rtc_cntl = $crate::peripherals::LPWR::regs();
                        let gpio_wakeup = rtc_cntl.gpio_wakeup();

                        unsafe {
                            gpio_wakeup.modify(|_, w| w.[< gpio_pin $pin_num _wakeup_enable >]().bit(wakeup));
                            gpio_wakeup.modify(|_, w| w.[< gpio_pin $pin_num _int_type >]().bits(level));
                        }
                    }

                    fn rtcio_pad_hold(&self, enable: bool) {
                        $crate::peripherals::LPWR::regs()
                            .pad_hold().modify(|_, w| w.[< gpio_pin $pin_num _hold >]().bit(enable));
                    }
                }

                #[cfg_attr(docsrs, doc(cfg(feature = "unstable")))]
                impl crate::gpio::RtcPinWithResistors for $crate::peripherals::[<GPIO $pin_num>]<'_> {
                    fn rtcio_pullup(&self, enable: bool) {
                        $crate::peripherals::IO_MUX::regs()
                            .gpio($pin_num)
                            .modify(|_, w| w.fun_wpu().bit(enable));
                    }

                    fn rtcio_pulldown(&self, enable: bool) {
                        $crate::peripherals::IO_MUX::regs()
                            .gpio($pin_num)
                            .modify(|_, w| w.fun_wpd().bit(enable));
                    }
                }
            }
        )+
    };
}

// RTC pins 0 through 5 (inclusive) support GPIO wakeup
rtc_pins! {
    0
    1
    2
    3
    4
    5
}