esp-hal-ota 0.1.4

OTA library for esp-hal
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

struct ExtMemDefs {}

#[cfg(all(
    not(feature = "esp32c3"),
    not(feature = "esp32s2"),
    not(feature = "esp32s3")
))]
impl ExtMemDefs {
    const SOC_MMU_VADDR_MASK: u32 = 0;
    const DR_REG_MMU_TABLE: u32 = 0;
    const SOC_MMU_VALID_VAL_MASK: u32 = 0;
    const SOC_MMU_INVALID: u32 = 0;
    const MMU_PAGE_SIZE: u32 = 0;
}

/*
#[cfg(feature = "esp32c2")]
impl ExtMemDefs {
    const SOC_MMU_VADDR_MASK: u32 = ExtMemDefs::MMU_PAGE_SIZE * 64 - 1;
    const DR_REG_MMU_TABLE: u32 = 0x600c5000;
    const SOC_MMU_VALID_VAL_MASK: u32 = 0x3f;
    const SOC_MMU_INVALID: u32 = 1 << 6;
    const MMU_PAGE_SIZE: u32 = 0x10000;
}
*/

#[cfg(feature = "esp32c3")]
impl ExtMemDefs {
    const SOC_MMU_VADDR_MASK: u32 = 0x7FFFFF;
    const DR_REG_MMU_TABLE: u32 = 0x600c5000;
    const SOC_MMU_VALID_VAL_MASK: u32 = 0xff;
    const SOC_MMU_INVALID: u32 = 1 << 8;
    const MMU_PAGE_SIZE: u32 = 0x10000;
}

#[cfg(feature = "esp32s2")]
impl ExtMemDefs {
    const SOC_MMU_VADDR_MASK: u32 = 0x3FFFFF;
    const DR_REG_MMU_TABLE: u32 = 0x61801000;
    const SOC_MMU_VALID_VAL_MASK: u32 = 0x3fff;
    const SOC_MMU_INVALID: u32 = 1 << 14;
    const MMU_PAGE_SIZE: u32 = 0x10000;
}

#[cfg(feature = "esp32s3")]
impl ExtMemDefs {
    const SOC_MMU_VADDR_MASK: u32 = 0x1FFFFFF;
    const DR_REG_MMU_TABLE: u32 = 0x600c5000;
    const SOC_MMU_VALID_VAL_MASK: u32 = 0x3fff;
    const SOC_MMU_INVALID: u32 = 1 << 14;
    const MMU_PAGE_SIZE: u32 = 0x10000;
}

// BUG: This might fail on esp32s2 (because getting entry_id is different there)
// https://github.com/espressif/esp-idf/blob/master/components/hal/esp32s2/include/hal/mmu_ll.h#L145
// https://github.com/espressif/esp-idf/blob/master/components/hal/esp32c3/include/hal/mmu_ll.h#L143
fn mmu_ll_get_entry_id(_mmu_id: u32, vaddr: u32) -> u32 {
    (vaddr & ExtMemDefs::SOC_MMU_VADDR_MASK) >> 16
}

#[allow(dead_code)]
fn mmu_ll_check_entry_valid(_mmu_id: u32, entry_id: u32) -> bool {
    let ptr = (ExtMemDefs::DR_REG_MMU_TABLE + entry_id * 4) as *const u32;
    unsafe { ((*ptr) & ExtMemDefs::SOC_MMU_INVALID) == 0 }
}

fn mmu_ll_entry_id_to_paddr_base(_mmu_id: u32, entry_id: u32) -> u32 {
    let ptr = (ExtMemDefs::DR_REG_MMU_TABLE + entry_id * 4) as *const u32;
    unsafe { ((*ptr) & ExtMemDefs::SOC_MMU_VALID_VAL_MASK) << 16 }
}

fn mmu_hal_pages_to_bytes(_mmu_id: u32, page_num: u32) -> u32 {
    let shift_code = match ExtMemDefs::MMU_PAGE_SIZE {
        0x10000 => 16,
        0x8000 => 15,
        0x4000 => 14,
        _ => panic!("WRONG MMU_PAGE SIZE! 0x{:X?}", ExtMemDefs::MMU_PAGE_SIZE),
    };

    page_num << shift_code
}

pub fn esp_get_current_running_partition(partitions: &[(u32, u32)]) -> Option<usize> {
    // we are using 0 as mmu_id - all code paths for esp32c3,esp32s2,esp32s3 arent using mmu_id

    let ptr = esp_get_current_running_partition as *const () as *const u32;
    let entry_id = mmu_ll_get_entry_id(0, ptr as u32);

    // page_num is always 1
    // https://github.com/espressif/esp-idf/blob/master/components/hal/mmu_hal.c#L129
    let page_size_in_bytes = mmu_hal_pages_to_bytes(0, 1);
    let offset = (ptr as u32) % page_size_in_bytes;

    let paddr_base = mmu_ll_entry_id_to_paddr_base(0, entry_id);
    let paddr = paddr_base | offset;

    for i in 0..partitions.len() {
        let part = partitions[i];

        if paddr >= part.0 && paddr < part.0 + part.1 {
            return Some(i);
        }
    }

    None
}