esp-hal 0.16.1

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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
use crate::clock::{Clock, CpuClock, PllClock, XtalClock};

extern "C" {
    fn ets_update_cpu_frequency(ticks_per_us: u32);
    fn ets_delay_us(delay: u32);

}

const DR_REG_LPAON_BASE: u32 = 0x50110000;
const DR_REG_LP_SYS_BASE: u32 = DR_REG_LPAON_BASE + 0x0;
const DR_REG_LPPERIPH_BASE: u32 = 0x50120000;
const DR_REG_I2C_ANA_MST_BASE: u32 = DR_REG_LPPERIPH_BASE + 0x4000;

const LPPERI_CLK_EN_REG: u32 = DR_REG_LPPERIPH_BASE + 0x0;
const LPPERI_CK_EN_LP_I2CMST: u32 = 1 << 27;

const I2C_CPLL_OC_DCHGP_LSB: u8 = 4;
const I2C_CPLL_OC_ENB_FCAL_LSB: u8 = 7;
const I2C_CPLL_OC_DLREF_SEL_LSB: u8 = 6;
const I2C_CPLL_OC_DHREF_SEL_LSB: u8 = 4;
const I2C_ANA_MST_CLK160M_REG: u32 = DR_REG_I2C_ANA_MST_BASE + 0x34;
const I2C_ANA_MST_CLK_I2C_MST_SEL_160M: u32 = 1 << 0;

const I2C_CPLL: u8 = 0x67;
const I2C_CPLL_HOSTID: u8 = 0;
const I2C_CPLL_OC_REF_DIV: u8 = 2;
const I2C_CPLL_OC_DIV_7_0: u8 = 3;
const I2C_CPLL_OC_DCUR: u8 = 6;

const I2C_ANA_MST_ANA_CONF1_REG: u32 = DR_REG_I2C_ANA_MST_BASE + 0x1C;
const I2C_ANA_MST_ANA_CONF1: u32 = 0x00FFFFFF;
const I2C_ANA_MST_ANA_CONF1_V: u32 = 0xFFFFFF;
const I2C_ANA_MST_ANA_CONF1_S: u32 = 0;

const I2C_ANA_MST_ANA_CONF2_REG: u32 = DR_REG_I2C_ANA_MST_BASE + 0x20;
const I2C_ANA_MST_ANA_CONF2: u32 = 0x00FFFFFF;
const I2C_ANA_MST_ANA_CONF2_V: u32 = 0xFFFFFF;
const I2C_ANA_MST_ANA_CONF2_S: u32 = 0;

const REGI2C_RTC_SLAVE_ID_V: u8 = 0xFF;
const REGI2C_RTC_SLAVE_ID_S: u8 = 0;
const REGI2C_RTC_ADDR_V: u8 = 0xFF;
const REGI2C_RTC_ADDR_S: u8 = 8;
const REGI2C_RTC_WR_CNTL_V: u8 = 0x1;
const REGI2C_RTC_WR_CNTL_S: u8 = 24;
const REGI2C_RTC_DATA_V: u8 = 0xFF;
const REGI2C_RTC_DATA_S: u8 = 16;
const REGI2C_RTC_BUSY: u32 = 1 << 25;

const I2C_ANA_MST_I2C0_CTRL_REG: u32 = DR_REG_I2C_ANA_MST_BASE + 0x0;

const DR_REG_PMU_BASE: u32 = DR_REG_LPAON_BASE + 0x5000;
const PMU_IMM_HP_CK_POWER: u32 = DR_REG_PMU_BASE + 0xcc;
const PMU_TIE_HIGH_XPD_CPLL: u32 = 1 << 27;
const PMU_TIE_HIGH_XPD_CPLL_I2C: u32 = 1 << 23;
const PMU_TIE_HIGH_GLOBAL_CPLL_ICG: u32 = 1 << 17;

const DR_REG_HPPERIPH1_BASE: u32 = 0x500C0000;
const DR_REG_HP_SYS_CLKRST_BASE: u32 = DR_REG_HPPERIPH1_BASE + 0x26000;
const HP_SYS_CLKRST_ANA_PLL_CTRL0: u32 = DR_REG_HP_SYS_CLKRST_BASE + 0xbc;
const HP_SYS_CLKRST_REG_CPU_PLL_CAL_STOP: u32 = 1 << 3;
const HP_SYS_CLKRST_REG_CPU_PLL_CAL_END: u32 = 1 << 2;
const HP_SYS_CLKRST_REG_CPU_CLK_DIV_NUM_V: u32 = 0x000000FF;

const REGI2C_DIG_REG: u8 = 0x6d;
const REGI2C_CPU_PLL: u8 = 0x67;
const REGI2C_SDIO_PLL: u8 = 0x62;
const REGI2C_BIAS: u8 = 0x6a;
const REGI2C_MSPI: u8 = 0x63;
const REGI2C_SYS_PLL: u8 = 0x66;
const REGI2C_PLLA: u8 = 0x6f;
const REGI2C_SAR_I2C: u8 = 0x69;

const REGI2C_DIG_REG_MST_SEL: u32 = 1 << 10;
const REGI2C_PLL_CPU_MST_SEL: u32 = 1 << 11;
const REGI2C_PLL_SDIO_MST_SEL: u32 = 1 << 6;
const REGI2C_BIAS_MST_SEL: u32 = 1 << 12;
const REGI2C_MSPI_XTAL_MST_SEL: u32 = 1 << 9;
const REGI2C_PLL_SYS_MST_SEL: u32 = 1 << 5;
const REGI2C_PLLA_MST_SEL: u32 = 1 << 8;
const REGI2C_SAR_I2C_MST_SEL: u32 = 1 << 7;

const RTC_XTAL_FREQ_REG: u32 = DR_REG_LP_SYS_BASE + 0x3c;
const RTC_DISABLE_ROM_LOG: u32 = (1 << 0) | (1 << 16);

// rtc_clk.c (L125) -> clk_tree_ll.h
pub(crate) fn esp32p4_rtc_cpll_enable() {
    unsafe {
        (PMU_IMM_HP_CK_POWER as *mut u32).write_volatile(
            (PMU_IMM_HP_CK_POWER as *mut u32).read_volatile()
                | (PMU_TIE_HIGH_XPD_CPLL | PMU_TIE_HIGH_XPD_CPLL_I2C),
        );

        (PMU_IMM_HP_CK_POWER as *mut u32).write_volatile(
            (PMU_IMM_HP_CK_POWER as *mut u32).read_volatile() | PMU_TIE_HIGH_GLOBAL_CPLL_ICG,
        )
    }
}

// rtc_clk.c (L136)
pub(crate) fn esp32p4_rtc_cpll_configure(xtal_freq: XtalClock, cpll_freq: PllClock) {
    // CPLL CALIBRATION START
    unsafe {
        (HP_SYS_CLKRST_ANA_PLL_CTRL0 as *mut u32).write_volatile(
            (HP_SYS_CLKRST_ANA_PLL_CTRL0 as *mut u32).read_volatile()
                | !HP_SYS_CLKRST_REG_CPU_PLL_CAL_STOP,
        );
    }

    // Set configuration
    let mut oc_div_ref = 0u32;
    let mut div = 1u32;
    let dcur = 3u32;
    let dchgp = 5u32;
    let enb_fcal = 0u32;

    // Currently only supporting 40MHz XTAL
    assert!(xtal_freq.mhz() == XtalClock::RtcXtalFreq40M.mhz());

    match cpll_freq {
        PllClock::Pll400MHz => {
            div = 6u32;
            oc_div_ref = 0u32;
        }
        PllClock::Pll360MHz => {
            div = 5u32;
            oc_div_ref = 0u32;
        }
        _ => (),
    }

    let i2c_cpll_lref =
        (enb_fcal << I2C_CPLL_OC_ENB_FCAL_LSB) | (dchgp << I2C_CPLL_OC_DCHGP_LSB) | (oc_div_ref);

    let i2c_cpll_dcur = (1 << I2C_CPLL_OC_DLREF_SEL_LSB) | (3 << I2C_CPLL_OC_DHREF_SEL_LSB) | dcur;

    regi2c_write(
        I2C_CPLL,
        I2C_CPLL_HOSTID,
        I2C_CPLL_OC_REF_DIV,
        i2c_cpll_lref as u8,
    );

    regi2c_write(I2C_CPLL, I2C_CPLL_HOSTID, I2C_CPLL_OC_DIV_7_0, div as u8);

    regi2c_write(
        I2C_CPLL,
        I2C_CPLL_HOSTID,
        I2C_CPLL_OC_DCUR,
        i2c_cpll_dcur as u8,
    );

    // Wait calibration done
    while !reg_get_bit(
        HP_SYS_CLKRST_ANA_PLL_CTRL0,
        HP_SYS_CLKRST_REG_CPU_PLL_CAL_END,
    ) == 1
    {}

    unsafe {
        ets_delay_us(10);
    }

    // CPLL calibration stop
    set_peri_reg_mask(
        HP_SYS_CLKRST_ANA_PLL_CTRL0,
        HP_SYS_CLKRST_REG_CPU_PLL_CAL_STOP,
    );
}

// rtc_clk.c (L161)
pub(crate) fn esp32p4_rtc_update_to_xtal(freq: XtalClock, div: u8, default: bool) {
    let mut mem_divider = 1u32;
    let mut sys_divider = 1u32;
    let apb_divider = 1u32;

    if default {
        mem_divider = 2u32;
        sys_divider = 2u32;
    }

    // clk_ll_cpu_set_src(SOC_CPU_CLK_SRC_XTAL -> 0)
    unsafe {
        (&*crate::soc::peripherals::LP_AON_CLKRST::PTR)
            .lp_aonclkrst_hp_clk_ctrl()
            .modify(|_, w| w.lp_aonclkrst_hp_root_clk_src_sel().bits(0b00))
    }

    // clk_ll_cpu_set_divider(div, 0, 0) ->
    // clk_tree_ll.h(comp/hal/p4/include/hal/L407)
    assert!(div >= 1 && (div as u32) < HP_SYS_CLKRST_REG_CPU_CLK_DIV_NUM_V);

    // Set CPU divider
    unsafe {
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.cpu_clk_div_num().bits(div - 1));

        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.cpu_clk_div_numerator().bits(0));

        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.cpu_clk_div_denominator().bits(0));

        // Set memory divider
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl1()
            .modify(|_, w| w.mem_clk_div_num().bits((mem_divider - 1) as u8));

        // Set system divider
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl1()
            .modify(|_, w| w.sys_clk_div_num().bits((sys_divider - 1) as u8));

        // Set APB divider
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl2()
            .modify(|_, w| w.apb_clk_div_num().bits((apb_divider - 1) as u8));

        // Bus update
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.soc_clk_div_update().set_bit());

        while (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .read()
            .soc_clk_div_update()
            .bit_is_set()
        {}

        ets_update_cpu_frequency(freq.mhz());
    }
}

// esp_rom_regi2c_esp32p4.c (L84)
fn regi2c_enable_block(block: u8) {
    reg_set_bit(LPPERI_CLK_EN_REG, LPPERI_CK_EN_LP_I2CMST);
    set_peri_reg_mask(I2C_ANA_MST_CLK160M_REG, I2C_ANA_MST_CLK_I2C_MST_SEL_160M);

    reg_set_field(
        I2C_ANA_MST_ANA_CONF2_REG,
        I2C_ANA_MST_ANA_CONF2_V,
        I2C_ANA_MST_ANA_CONF2_S,
        0,
    );

    reg_set_field(
        I2C_ANA_MST_ANA_CONF1_REG,
        I2C_ANA_MST_ANA_CONF1_V,
        I2C_ANA_MST_ANA_CONF1_S,
        0,
    );

    match block {
        REGI2C_DIG_REG => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_DIG_REG_MST_SEL);
        }
        REGI2C_CPU_PLL => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLL_CPU_MST_SEL);
        }
        REGI2C_SDIO_PLL => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLL_SDIO_MST_SEL);
        }
        REGI2C_BIAS => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_BIAS_MST_SEL);
        }
        REGI2C_MSPI => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_MSPI_XTAL_MST_SEL);
        }
        REGI2C_SYS_PLL => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLL_SYS_MST_SEL);
        }
        REGI2C_PLLA => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLLA_MST_SEL);
        }
        REGI2C_SAR_I2C => {
            reg_set_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_SAR_I2C_MST_SEL);
        }
        _ => (),
    }
}

pub(crate) fn esp32p4_rtc_freq_to_cpll_mhz(cpu_clock_speed: CpuClock) {
    // CPLL -> CPU_CLK -> MEM_CLK -> SYS_CLK -> APB_CLK
    // Constraint: MEM_CLK <= 200MHz, APB_CLK <= 100MHz
    // This implies that when clock source is CPLL,
    //                   If cpu_divider < 2, mem_divider must be larger or equal to
    // 2                   If cpu_divider < 2, mem_divider = 2, sys_divider < 2,
    // apb_divider must be larger or equal to 2 Current available
    // configurations: 360  -   360   -    180    -    180   -    90
    // 360  -   180   -    180    -    180   -    90
    // 360  -   90    -    90     -    90    -    90

    // freq_mhz_to_config part (rtc_clk.c L251)

    // rtc_clk_xtal_freq_get() -> xtal_load_freq_mhz()
    let xtal_freq_reg = unsafe { (RTC_XTAL_FREQ_REG as *mut u32).read_volatile() as u32 };
    let mut xtal_freq = 0u32;

    let mut real_freq = 0u32;

    let mut div_integer = 0u32;
    let div_denominator = 0u32;
    let mut div_numerator = 0u32;

    if (xtal_freq_reg & 0xFFFF) == ((xtal_freq_reg >> 16) & 0xFFFF)
        && xtal_freq_reg != 0
        && xtal_freq_reg != u32::MAX
    {
        xtal_freq = xtal_freq_reg & !RTC_DISABLE_ROM_LOG & u16::MAX as u32;
    }

    // Keep default CPLL at 360 MHz
    if cpu_clock_speed.mhz() <= xtal_freq {
        div_integer = xtal_freq / cpu_clock_speed.mhz();
        real_freq = (xtal_freq + div_integer / 2) / div_integer; // round

        // Check whether divider is suitable
        assert!(real_freq == cpu_clock_speed.mhz());
    } else {
        div_integer = 1;
    }

    let mut mem_div = 0u32;
    let mut sys_div = 0u32;
    let mut apb_div = 0u32;

    match cpu_clock_speed {
        CpuClock::Clock360MHz => {
            mem_div = 2;
            apb_div = 2;
        }
        CpuClock::Clock180MHz => {
            mem_div = 1;
            apb_div = 2;
        }
        CpuClock::Clock90MHz => {
            mem_div = 1;
            apb_div = 1;
        }
        _ => {
            panic!("Unsupported configuration")
        }
    }

    // clk_ll_cpu_set_src(SOC_CPU_CLK_SRC_PLL); (rtc_clk.c L242)
    unsafe {
        (&*crate::soc::peripherals::LP_AON_CLKRST::PTR)
            .lp_aonclkrst_hp_clk_ctrl()
            .modify(|_, w| w.lp_aonclkrst_hp_root_clk_src_sel().bits(0b01));

        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.cpu_clk_div_num().bits((div_integer - 1) as u8));

        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.cpu_clk_div_numerator().bits(0));

        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.cpu_clk_div_denominator().bits(0));

        // Set memory divider
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl1()
            .modify(|_, w| w.mem_clk_div_num().bits((mem_div - 1) as u8));

        // Set system divider
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl1()
            .modify(|_, w| w.sys_clk_div_num().bits((sys_div - 1) as u8));

        // Set APB divider
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl2()
            .modify(|_, w| w.apb_clk_div_num().bits((apb_div - 1) as u8));

        // Bus update
        (&*crate::soc::peripherals::HP_SYS_CLKRST::PTR)
            .root_clk_ctrl0()
            .modify(|_, w| w.soc_clk_div_update().set_bit());

        ets_update_cpu_frequency(cpu_clock_speed.mhz());
    }
}

fn regi2c_disable_block(block: u8) {
    match block {
        REGI2C_DIG_REG => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_DIG_REG_MST_SEL);
        }
        REGI2C_CPU_PLL => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLL_CPU_MST_SEL);
        }
        REGI2C_SDIO_PLL => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLL_SDIO_MST_SEL);
        }
        REGI2C_BIAS => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_BIAS_MST_SEL);
        }
        REGI2C_MSPI => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_MSPI_XTAL_MST_SEL);
        }
        REGI2C_SYS_PLL => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLL_SYS_MST_SEL);
        }
        REGI2C_PLLA => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_PLLA_MST_SEL);
        }
        REGI2C_SAR_I2C => {
            reg_clr_bit(I2C_ANA_MST_ANA_CONF2_REG, REGI2C_SAR_I2C_MST_SEL);
        }
        _ => (),
    }
}

pub(crate) fn regi2c_write(block: u8, _host_id: u8, reg_add: u8, data: u8) {
    regi2c_enable_block(block);

    let temp: u32 = ((block as u32 & REGI2C_RTC_SLAVE_ID_V as u32) << REGI2C_RTC_SLAVE_ID_S as u32)
    | ((reg_add as u32 & REGI2C_RTC_ADDR_V as u32) << REGI2C_RTC_ADDR_S as u32)
    | ((0x1 & REGI2C_RTC_WR_CNTL_V as u32) << REGI2C_RTC_WR_CNTL_S as u32) // 0: READ I2C register; 1: Write I2C register;
    | (((data as u32) & REGI2C_RTC_DATA_V as u32) << REGI2C_RTC_DATA_S as u32);
    reg_write(I2C_ANA_MST_I2C0_CTRL_REG, temp);
    while reg_get_bit(I2C_ANA_MST_I2C0_CTRL_REG, REGI2C_RTC_BUSY) != 0 {}

    regi2c_disable_block(block);
}

fn reg_set_field(reg: u32, field_v: u32, field_s: u32, value: u32) {
    unsafe {
        (reg as *mut u32).write_volatile(
            ((reg as *mut u32).read_volatile() & !(field_v << field_s))
                | ((value & field_v) << field_s),
        )
    }
}

fn reg_set_bit(reg: u32, bit: u32) {
    unsafe {
        (reg as *mut u32).write_volatile((reg as *mut u32).read_volatile() | bit);
    }
}

fn reg_write(reg: u32, v: u32) {
    unsafe {
        (reg as *mut u32).write_volatile(v);
    }
}

fn reg_get_bit(reg: u32, b: u32) -> u32 {
    unsafe { (reg as *mut u32).read_volatile() & b }
}

fn reg_clr_bit(reg: u32, bit: u32) {
    unsafe {
        (reg as *mut u32).write_volatile((reg as *mut u32).read_volatile() & !bit);
    }
}

fn set_peri_reg_mask(reg: u32, mask: u32) {
    unsafe {
        (reg as *mut u32).write_volatile((reg as *mut u32).read_volatile() | mask);
    }
}