espflash 0.1.1

ESP8266 and ESP32 serial flasher
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

use std::borrow::Cow;
use std::io::Write;
use std::iter::once;
use std::mem::size_of;

use super::{ChipType, ESPCommonHeader, SegmentHeader, ESP_MAGIC};
use crate::chip::{Chip, SPIRegisters};
use crate::elf::{update_checksum, FirmwareImage, RomSegment, ESP_CHECKSUM_MAGIC};
use crate::flasher::FlashSize;
use crate::Error;
use bytemuck::bytes_of;

pub const IROM_MAP_START: u32 = 0x40200000;
const IROM_MAP_END: u32 = 0x40300000;

pub struct ESP8266;

impl ChipType for ESP8266 {
    const DATE_REG1_VALUE: u32 = 0x00062000;
    const DATE_REG2_VALUE: u32 = 0;
    const SPI_REGISTERS: SPIRegisters = SPIRegisters {
        base: 0x60000200,
        usr_offset: 0x1c,
        usr1_offset: 0x20,
        usr2_offset: 0x24,
        w0_offset: 0x40,
        mosi_length_offset: None,
        miso_length_offset: None,
    };

    fn addr_is_flash(addr: u32) -> bool {
        addr >= IROM_MAP_START && addr < IROM_MAP_END
    }

    fn get_flash_segments<'a>(
        image: &'a FirmwareImage,
    ) -> Box<dyn Iterator<Item = Result<RomSegment<'a>, Error>> + 'a> {
        // irom goes into a separate plain bin
        let irom_data = image.rom_segments(Chip::Esp8266).map(|segment| {
            Ok(RomSegment {
                addr: segment.addr - IROM_MAP_START,
                data: Cow::Borrowed(segment.data),
            })
        });

        // my kingdom for a try {} block
        fn common<'a>(image: &'a FirmwareImage) -> Result<RomSegment<'a>, Error> {
            let mut common_data = Vec::with_capacity(
                image
                    .ram_segments(Chip::Esp8266)
                    .map(|segment| segment.size as usize)
                    .sum(),
            );
            // common header
            let header = ESPCommonHeader {
                magic: ESP_MAGIC,
                segment_count: image.ram_segments(Chip::Esp8266).count() as u8,
                flash_mode: image.flash_mode as u8,
                flash_config: encode_flash_size(image.flash_size)? + image.flash_frequency as u8,
                entry: image.entry,
            };
            common_data.write(bytes_of(&header))?;

            let mut total_len = 8;

            let mut checksum = ESP_CHECKSUM_MAGIC;

            for segment in image.ram_segments(Chip::Esp8266) {
                let data = segment.data;
                let padding = 4 - data.len() % 4;
                let segment_header = SegmentHeader {
                    addr: segment.addr,
                    length: (data.len() + padding) as u32,
                };
                total_len += size_of::<SegmentHeader>() as u32 + segment_header.length;
                common_data.write(bytes_of(&segment_header))?;
                common_data.write(data)?;

                let padding = &[0u8; 4][0..padding];
                common_data.write(padding)?;
                checksum = update_checksum(data, checksum);
            }

            let padding = 15 - (total_len % 16);
            let padding = &[0u8; 16][0..padding as usize];
            common_data.write(padding)?;

            common_data.write(&[checksum])?;

            Ok(RomSegment {
                addr: 0,
                data: Cow::Owned(common_data),
            })
        }

        Box::new(irom_data.chain(once(common(image))))
    }
}

fn encode_flash_size(size: FlashSize) -> Result<u8, Error> {
    Ok(match size {
        FlashSize::Flash256KB => 0x10,
        FlashSize::Flash512KB => 0x00,
        FlashSize::Flash1MB => 0x20,
        FlashSize::Flash2MB => 0x30,
        FlashSize::Flash4MB => 0x40,
        FlashSize::Flash8MB => 0x80,
        FlashSize::Flash16MB => 0x90,
    })
}

#[test]
fn test_esp8266_rom() {
    use pretty_assertions::assert_eq;
    use std::fs::read;

    let input_bytes = read("./tests/data/esp8266").unwrap();
    let expected_bin = read("./tests/data/esp8266.bin").unwrap();

    let image = FirmwareImage::from_data(&input_bytes).unwrap();

    let segments = ESP8266::get_flash_segments(&image)
        .collect::<Result<Vec<_>, Error>>()
        .unwrap();

    assert_eq!(1, segments.len());
    let buff = segments[0].data.as_ref();
    assert_eq!(expected_bin.len(), buff.len());
    assert_eq!(expected_bin.as_slice(), buff);
}