esp-idf-hal 0.46.1

A Hardware abstraction layer for Espressif's ESP family of microcontrollers based on the ESP-IDF framework.
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

use core::borrow::Borrow;
use core::marker::PhantomData;
use core::sync::atomic::{AtomicU8, Ordering};

use crate::gpio::{InputPin, OutputPin};
use crate::spi::SpiDriver;
use crate::sys::*;

static USED: AtomicU8 = AtomicU8::new(0);
static USED_CS: crate::task::CriticalSection = crate::task::CriticalSection::new();

/// SPI Host driver for SD cards supporting the SPI protocol.
pub struct SdSpiHostDriver<'d, T> {
    _spi_driver: T,
    handle: sdspi_dev_handle_t,
    _p: PhantomData<&'d mut ()>,
}

impl<'d, T> SdSpiHostDriver<'d, T>
where
    T: Borrow<SpiDriver<'d>>,
{
    /// Create a new SPI host driver for SD cards
    ///
    /// # Arguments
    /// - spi_driver: SPI peripheral driver
    /// - cs: Chip Select pin (optional)
    /// - cd: Card Detect pin (optional)
    /// - wp: Write Protect pin (optional)
    /// - int: Interrupt pin (optional)
    /// - wp_active_high: Write Protect active when high (optional, default = `false`)
    pub fn new(
        spi_driver: T,
        cs: Option<impl OutputPin + 'd>,
        cd: Option<impl InputPin + 'd>,
        wp: Option<impl InputPin + 'd>,
        int: Option<impl InputPin + 'd>,
        #[cfg(not(any(
            esp_idf_version_major = "4",
            all(esp_idf_version_major = "5", esp_idf_version_minor = "0"),
            all(esp_idf_version_major = "5", esp_idf_version_minor = "1"),
        )))] // For ESP-IDF v5.2 and later
        wp_active_high: Option<bool>,
    ) -> Result<Self, EspError>
    where
        T: Borrow<SpiDriver<'d>>,
    {
        #[allow(clippy::needless_update)]
        let dev_config = sdspi_device_config_t {
            host_id: spi_driver.borrow().host(),
            gpio_cs: cs.map(|cs| cs.pin() as _).unwrap_or(-1),
            gpio_cd: cd.map(|cd| cd.pin() as _).unwrap_or(-1),
            gpio_wp: wp.map(|wp| wp.pin() as _).unwrap_or(-1),
            gpio_int: int.map(|int| int.pin() as _).unwrap_or(-1),
            #[cfg(not(any(
                esp_idf_version_major = "4",
                all(esp_idf_version_major = "5", esp_idf_version_minor = "0"),
                all(esp_idf_version_major = "5", esp_idf_version_minor = "1"),
            )))] // For ESP-IDF v5.2 and later
            gpio_wp_polarity: wp_active_high.unwrap_or(false), // `false` = active when low
            ..Default::default() // `duty_cycle_pos` = 128 (or 0 which is equivalent) - since ESP-IDF V5.4
        };

        {
            let _cs = USED_CS.enter();

            if USED.load(Ordering::SeqCst) == 0 {
                esp!(unsafe { sdspi_host_init() })?;

                USED.fetch_add(1, Ordering::SeqCst);
            }
        }

        let mut handle = 0;

        esp!(unsafe { sdspi_host_init_device(&dev_config, &mut handle) })?;

        Ok(Self {
            _spi_driver: spi_driver,
            handle,
            _p: PhantomData,
        })
    }

    pub fn handle(&self) -> sdspi_dev_handle_t {
        self.handle
    }
}

impl<T> Drop for SdSpiHostDriver<'_, T> {
    fn drop(&mut self) {
        esp!(unsafe { sdspi_host_remove_device(self.handle) }).unwrap();

        {
            let _cs = USED_CS.enter();

            if USED.fetch_sub(1, Ordering::SeqCst) == 1 {
                esp!(unsafe { sdspi_host_deinit() }).unwrap();
            }
        }
    }
}