i8051 0.13.0

An emulator for the i8051 (MCS-51) microcontroller.
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

use std::borrow::Cow;
use std::collections::BTreeMap;

use crate::cpu::Flag;
use crate::{Cpu, CpuContext, Register};

use tracing::{Level, info};

pub enum Action {
    /// Log a message to the console.
    Log(Level, Cow<'static, str>),
    /// Set a register to a value.
    Set(Register, u16),
    /// Enable or disable tracing of instructions.
    SetTraceInstructions(bool),
    /// Enable or disable automatic tracing of registers.
    SetTraceRegisters(bool),
    /// Trace current instruction.
    TraceInstructions,
    /// Trace the current state of the CPU.
    TraceRegisters,
    /// Run an arbitrary function.
    Run(Box<dyn Fn(&mut Cpu)>),
}

impl Action {
    fn run(&self, cpu: &mut Cpu, breakpoints: &mut BreakpointState, ctx: &impl CpuContext) {
        match self {
            Self::Log(Level::DEBUG, message) => {
                tracing::debug!(target: "bp", "[BP] {}", message);
            }
            Self::Log(Level::INFO, message) => {
                tracing::info!(target: "bp", "[BP] {}", message);
            }
            Self::Log(Level::WARN, message) => {
                tracing::warn!(target: "bp", "[BP] {}", message);
            }
            Self::Log(Level::ERROR, message) => {
                tracing::error!(target: "bp", "[BP] {}", message);
            }
            Self::Log(Level::TRACE, message) => {
                tracing::trace!(target: "bp", "[BP] {}", message);
            }
            Self::Set(register, value) => cpu.register_set(*register, *value),
            Self::SetTraceInstructions(value) => breakpoints.trace_instructions = *value,
            Self::SetTraceRegisters(value) => breakpoints.trace_registers = *value,
            Self::TraceInstructions => {
                info!("{:#}", cpu.decode_pc(ctx));
            }
            Self::TraceRegisters => {
                if tracing::enabled!(Level::INFO) {
                    let regs = format!(
                        "  A={:02X?}  B={:02X?}  DPTR={:04X?}  C={} OV={} AC={} F0={}",
                        cpu.a(),
                        cpu.b(),
                        cpu.dptr(),
                        cpu.psw(Flag::C) as u8,
                        cpu.psw(Flag::OV) as u8,
                        cpu.psw(Flag::AC) as u8,
                        cpu.psw(Flag::F0) as u8
                    );

                    info!("{}", regs);

                    let mut regs = String::from("  ");
                    for i in 0..8 {
                        regs.push_str(&format!("R{}={:02X?} ", i, cpu.r(i)));
                    }
                    regs.push('\n');
                    info!("{}", regs);
                }
            }
            Self::Run(func) => func(cpu),
        }
    }
}

#[derive(Default)]
struct BreakpointState {
    trace_instructions: bool,
    trace_registers: bool,
}

#[derive(Default)]
pub struct Breakpoints {
    breakpoints_before: BTreeMap<u32, Vec<Action>>,
    breakpoints_after: BTreeMap<u32, Vec<Action>>,
    state: BreakpointState,
}

impl Breakpoints {
    pub fn new() -> Self {
        Self {
            breakpoints_before: BTreeMap::new(),
            breakpoints_after: BTreeMap::new(),
            state: Default::default(),
        }
    }

    pub fn add(&mut self, before: bool, addr: u32, action: Action) {
        if before {
            self.breakpoints_before
                .entry(addr)
                .or_default()
                .push(action);
        } else {
            self.breakpoints_after.entry(addr).or_default().push(action);
        }
    }

    pub fn remove(&mut self, addr: u32) {
        self.breakpoints_before.remove(&addr);
        self.breakpoints_after.remove(&addr);
    }

    pub fn clear(&mut self) {
        self.breakpoints_before.clear();
        self.breakpoints_after.clear();
    }

    pub fn run(&mut self, before: bool, cpu: &mut Cpu, ctx: &mut impl CpuContext) {
        let pc = cpu.pc_ext(ctx);

        let actions = if before {
            self.breakpoints_before
                .get(&pc)
                .map(|actions| actions.as_slice())
                .unwrap_or(&[])
        } else {
            self.breakpoints_after
                .get(&pc)
                .map(|actions| actions.as_slice())
                .unwrap_or(&[])
        };
        for action in actions {
            action.run(cpu, &mut self.state, ctx);
        }
        if self.state.trace_instructions && before {
            Action::TraceInstructions.run(cpu, &mut self.state, ctx);
        }
        if self.state.trace_registers && !before {
            Action::TraceRegisters.run(cpu, &mut self.state, ctx);
        }
    }
}