gdbstub 0.7.10

An implementation of the GDB Remote Serial Protocol in Rust
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

//! Provide flash operations on the target.
use crate::arch::Arch;
use crate::target::Target;
use crate::target::TargetResult;

/// Flash memory operations.
/// It's necessary to implement this extension to support GDB `load` command.
///
/// Typically, a GDB `load` command sequence starts by issuing a `flash_erase`
/// command, followed by multiple `flash_write` commands (typically one for each
/// loadable ELF section), and ends with a `flash_done` command.
///
/// The regions containing the addresses to be flashed must be specified as
/// "flash" regions in the memory map xml, returned by
/// [MemoryMap::memory_map_xml][crate::target::ext::memory_map::MemoryMap::memory_map_xml].
pub trait Flash: Target {
    /// Erase `length` bytes of the target's flash memory starting from
    /// `start_addr`.
    ///
    /// GDB ensures `start_addr` and `length` are aligned to flash memory
    /// block boundaries as defined by the memory map xml.
    fn flash_erase(
        &mut self,
        start_addr: <Self::Arch as Arch>::Usize,
        length: <Self::Arch as Arch>::Usize,
    ) -> TargetResult<(), Self>;

    /// Write bytes to the target's flash memory.
    ///
    /// GDB guarantees that the memory ranges specified by `flash_write`
    /// commands sent before a `flash_done` do not overlap and appear in
    /// order of increasing addresses.
    ///
    /// See [GDB Documentation] for more details.
    ///
    /// [GDB Documentation]: https://sourceware.org/gdb/current/onlinedocs/gdb.html/Packets.html
    fn flash_write(
        &mut self,
        start_addr: <Self::Arch as Arch>::Usize,
        data: &[u8],
    ) -> TargetResult<(), Self>;

    /// Indicate to the target that flash programming is finished.
    ///
    /// By GDB documentation, you can batch flash erase and write operations
    /// until this is called.
    fn flash_done(&mut self) -> TargetResult<(), Self>;
}

define_ext!(FlashOps, Flash);