esp-hal 1.1.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
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

use crate::{analog::adc::Attenuation, peripherals::EFUSE};

#[cfg_attr(not(feature = "unstable"), allow(dead_code))]
mod fields;
#[instability::unstable]
pub use fields::*;

/// Selects which ADC we are interested in the efuse calibration data for
#[instability::unstable]
pub enum AdcCalibUnit {
    /// Select efuse calibration data for ADC1
    ADC1,
    /// Select efuse calibration data for ADC2
    ADC2,
}

/// Get status of SPI boot encryption.
#[instability::unstable]
pub fn flash_encryption() -> bool {
    !super::read_field_le::<u8>(SPI_BOOT_CRYPT_CNT)
        .count_ones()
        .is_multiple_of(2)
}

/// Get the multiplier for the timeout value of the RWDT STAGE 0 register.
#[instability::unstable]
pub fn rwdt_multiplier() -> u8 {
    super::read_field_le::<u8>(WDT_DELAY_SEL)
}

/// Get efuse block version
///
/// see <https://github.com/espressif/esp-idf/blob/dc016f5987/components/hal/efuse_hal.c#L27-L30>
#[instability::unstable]
pub fn block_version() -> (u8, u8) {
    // see <https://github.com/espressif/esp-idf/blob/dc016f5987/components/hal/esp32s3/include/hal/efuse_ll.h#L65-L73>
    // <https://github.com/espressif/esp-idf/blob/903af13e8/components/efuse/esp32s3/esp_efuse_table.csv#L196>
    (
        super::read_field_le::<u8>(BLK_VERSION_MAJOR),
        super::read_field_le::<u8>(BLK_VERSION_MINOR),
    )
}

/// Get version of RTC calibration block
///
/// see <https://github.com/espressif/esp-idf/blob/903af13e8/components/efuse/esp32s3/esp_efuse_rtc_calib.c#L15>
#[instability::unstable]
pub fn rtc_calib_version() -> u8 {
    let (major, _minor) = block_version();

    if major == 1 { 1 } else { 0 }
}

/// Get ADC initial code for specified attenuation from efuse
///
/// see <https://github.com/espressif/esp-idf/blob/903af13e8/components/efuse/esp32s3/esp_efuse_rtc_calib.c#L28>
#[instability::unstable]
pub fn rtc_calib_init_code(unit: AdcCalibUnit, atten: Attenuation) -> Option<u16> {
    let version = rtc_calib_version();

    if version != 1 {
        return None;
    }

    let adc_icode_diff: [u16; 4] = match unit {
        AdcCalibUnit::ADC1 => [
            super::read_field_le(ADC1_INIT_CODE_ATTEN0),
            super::read_field_le(ADC1_INIT_CODE_ATTEN1),
            super::read_field_le(ADC1_INIT_CODE_ATTEN2),
            super::read_field_le(ADC1_INIT_CODE_ATTEN3),
        ],
        AdcCalibUnit::ADC2 => [
            super::read_field_le(ADC2_INIT_CODE_ATTEN0),
            super::read_field_le(ADC2_INIT_CODE_ATTEN1),
            super::read_field_le(ADC2_INIT_CODE_ATTEN2),
            super::read_field_le(ADC2_INIT_CODE_ATTEN3),
        ],
    };

    // Version 1 logic for calculating ADC ICode based on EFUSE burnt value

    let mut adc_icode = [0; 4];
    match unit {
        AdcCalibUnit::ADC1 => {
            adc_icode[0] = adc_icode_diff[0] + 1850;
            adc_icode[1] = adc_icode_diff[1] + adc_icode[0] + 90;
            adc_icode[2] = adc_icode_diff[2] + adc_icode[1];
            adc_icode[3] = adc_icode_diff[3] + adc_icode[2] + 70;
        }
        AdcCalibUnit::ADC2 => {
            adc_icode[0] = adc_icode_diff[0] + 2020;
            adc_icode[1] = adc_icode_diff[1] + adc_icode[0];
            adc_icode[2] = adc_icode_diff[2] + adc_icode[1];
            adc_icode[3] = adc_icode_diff[3] + adc_icode[2];
        }
    }

    Some(
        adc_icode[match atten {
            Attenuation::_0dB => 0,
            Attenuation::_2p5dB => 1,
            Attenuation::_6dB => 2,
            Attenuation::_11dB => 3,
        }],
    )
}

/// Get ADC reference point voltage for specified attenuation in millivolts
///
/// see <https://github.com/espressif/esp-idf/blob/903af13e8/components/efuse/esp32s3/esp_efuse_rtc_calib.c#L63>
#[instability::unstable]
pub fn rtc_calib_cal_mv(_unit: AdcCalibUnit, _atten: Attenuation) -> u16 {
    850
}

/// Get ADC reference point digital code for specified attenuation
///
/// see <https://github.com/espressif/esp-idf/blob/903af13e8/components/efuse/esp32s3/esp_efuse_rtc_calib.c#L63>
#[instability::unstable]
pub fn rtc_calib_cal_code(unit: AdcCalibUnit, atten: Attenuation) -> Option<u16> {
    let version = rtc_calib_version();

    if version != 1 {
        return None;
    }

    let adc_vol_diff: [u16; 8] = [
        super::read_field_le(ADC1_CAL_VOL_ATTEN0),
        super::read_field_le(ADC1_CAL_VOL_ATTEN1),
        super::read_field_le(ADC1_CAL_VOL_ATTEN2),
        super::read_field_le(ADC1_CAL_VOL_ATTEN3),
        super::read_field_le(ADC2_CAL_VOL_ATTEN0),
        super::read_field_le(ADC2_CAL_VOL_ATTEN1),
        super::read_field_le(ADC2_CAL_VOL_ATTEN2),
        super::read_field_le(ADC2_CAL_VOL_ATTEN3),
    ];

    let mut adc1_vol = [0; 4];
    let mut adc2_vol = [0; 4];
    adc1_vol[3] = adc_vol_diff[3] + 900;
    adc1_vol[2] = adc_vol_diff[2] + adc1_vol[3] + 800;
    adc1_vol[1] = adc_vol_diff[1] + adc1_vol[2] + 700;
    adc1_vol[0] = adc_vol_diff[0] + adc1_vol[1] + 800;
    adc2_vol[3] = adc1_vol[3] - adc_vol_diff[7] + 15;
    adc2_vol[2] = adc1_vol[2] - adc_vol_diff[6] + 20;
    adc2_vol[1] = adc1_vol[1] - adc_vol_diff[5] + 10;
    adc2_vol[0] = adc1_vol[0] - adc_vol_diff[4] + 40;

    let atten = match atten {
        Attenuation::_0dB => 0,
        Attenuation::_2p5dB => 1,
        Attenuation::_6dB => 2,
        Attenuation::_11dB => 3,
    };

    Some(match unit {
        AdcCalibUnit::ADC1 => adc1_vol[atten],
        AdcCalibUnit::ADC2 => adc2_vol[atten],
    })
}

/// Returns the major hardware revision
#[instability::unstable]
pub fn major_chip_version() -> u8 {
    super::read_field_le(WAFER_VERSION_MAJOR)
}

/// Returns the minor hardware revision
#[instability::unstable]
pub fn minor_chip_version() -> u8 {
    super::read_field_le::<u8>(WAFER_VERSION_MINOR_HI) << 3
        | super::read_field_le::<u8>(WAFER_VERSION_MINOR_LO)
}

#[derive(Debug, Clone, Copy, strum::FromRepr)]
#[repr(u32)]
pub(crate) enum EfuseBlock {
    Block0,
    Block1,
    Block2,
    Block3,
    Block4,
    Block5,
    Block6,
    Block7,
    Block8,
    Block9,
    Block10,
}

impl EfuseBlock {
    pub(crate) fn address(self) -> *const u32 {
        let efuse = EFUSE::regs();
        match self {
            Self::Block0 => efuse.rd_wr_dis().as_ptr(),
            Self::Block1 => efuse.rd_mac_spi_sys_0().as_ptr(),
            Self::Block2 => efuse.rd_sys_part1_data0().as_ptr(),
            Self::Block3 => efuse.rd_usr_data0().as_ptr(),
            Self::Block4 => efuse.rd_key0_data0().as_ptr(),
            Self::Block5 => efuse.rd_key1_data0().as_ptr(),
            Self::Block6 => efuse.rd_key2_data0().as_ptr(),
            Self::Block7 => efuse.rd_key3_data0().as_ptr(),
            Self::Block8 => efuse.rd_key4_data0().as_ptr(),
            Self::Block9 => efuse.rd_key5_data0().as_ptr(),
            Self::Block10 => efuse.rd_sys_part2_data0().as_ptr(),
        }
    }
}