probe-rs 0.31.0

use crate::{
    Core, CoreType, Error, Target,
    architecture::{
        arm::{
            ApV2Address, ArmDebugInterface, FullyQualifiedApAddress,
            core::{CortexAState, CortexMState},
            dp::DpAddress,
        },
        riscv::{RiscvCoreState, communication_interface::RiscvCommunicationInterface},
        xtensa::{XtensaCoreState, communication_interface::XtensaCommunicationInterface},
    },
};

use super::ResolvedCoreOptions;

#[derive(Debug)]
pub(crate) struct CombinedCoreState {
    pub(crate) core_state: CoreState,

    pub(crate) specific_state: SpecificCoreState,

    pub(crate) id: usize,
}

impl CombinedCoreState {
    pub fn id(&self) -> usize {
        self.id
    }

    pub fn core_type(&self) -> CoreType {
        self.specific_state.core_type()
    }

    pub fn jtag_tap_index(&self) -> usize {
        self.core_state.core_access_options.jtag_tap_index()
    }

    pub(crate) fn attach_arm<'probe>(
        &'probe mut self,
        target: &'probe Target,
        arm_interface: &'probe mut Box<dyn ArmDebugInterface>,
    ) -> Result<Core<'probe>, Error> {
        let name = &target.cores[self.id].name;

        let memory = arm_interface.memory_interface(&self.arm_memory_ap())?;

        let ResolvedCoreOptions::Arm { options, sequence } = &self.core_state.core_access_options
        else {
            unreachable!(
                "The stored core state is not compatible with the ARM architecture. \
                This should never happen. Please file a bug if it does."
            );
        };
        let debug_sequence = sequence.clone();

        Ok(match &mut self.specific_state {
            SpecificCoreState::Armv6m(s) => Core::new(
                self.id,
                name,
                target,
                crate::architecture::arm::armv6m::Armv6m::new(memory, s, debug_sequence)?,
            ),
            SpecificCoreState::Armv7a(s) => Core::new(
                self.id,
                name,
                target,
                crate::architecture::arm::armv7a::Armv7a::new(
                    memory,
                    s,
                    options.debug_base.expect("base_address not specified"),
                    debug_sequence,
                )?,
            ),
            SpecificCoreState::Armv7m(s) | SpecificCoreState::Armv7em(s) => Core::new(
                self.id,
                name,
                target,
                crate::architecture::arm::armv7m::Armv7m::new(memory, s, debug_sequence)?,
            ),
            SpecificCoreState::Armv8a(s) => Core::new(
                self.id,
                name,
                target,
                crate::architecture::arm::armv8a::Armv8a::new(
                    memory,
                    s,
                    options.debug_base.expect("base_address not specified"),
                    options.cti_base.expect("cti_address not specified"),
                    debug_sequence,
                )?,
            ),
            SpecificCoreState::Armv8m(s) => Core::new(
                self.id,
                name,
                target,
                crate::architecture::arm::armv8m::Armv8m::new(memory, s, debug_sequence)?,
            ),
            _ => {
                unreachable!(
                    "The stored core state is not compatible with the ARM architecture. \
                    This should never happen. Please file a bug if it does."
                );
            }
        })
    }

    pub(crate) fn enable_arm_debug(
        &self,
        interface: &mut dyn ArmDebugInterface,
    ) -> Result<(), Error> {
        let ResolvedCoreOptions::Arm { sequence, options } = &self.core_state.core_access_options
        else {
            unreachable!(
                "The stored core state is not compatible with the ARM architecture. \
                This should never happen. Please file a bug if it does."
            );
        };

        tracing::debug_span!("debug_core_start", id = self.id()).in_scope(|| {
            // Enable debug mode
            sequence.debug_core_start(
                interface,
                &self.arm_memory_ap(),
                self.core_type(),
                options.debug_base,
                options.cti_base,
            )
        })?;

        Ok(())
    }

    pub(crate) fn arm_reset_catch_set(
        &self,
        interface: &mut dyn ArmDebugInterface,
    ) -> Result<(), Error> {
        let ResolvedCoreOptions::Arm { sequence, options } = &self.core_state.core_access_options
        else {
            unreachable!(
                "The stored core state is not compatible with the ARM architecture. \
                This should never happen. Please file a bug if it does."
            );
        };

        let mut memory_interface = interface.memory_interface(&self.arm_memory_ap())?;

        let reset_catch_span = tracing::debug_span!("reset_catch_set", id = self.id()).entered();
        sequence.reset_catch_set(&mut *memory_interface, self.core_type(), options.debug_base)?;

        drop(reset_catch_span);

        Ok(())
    }

    pub(crate) fn attach_riscv<'probe>(
        &'probe mut self,
        target: &'probe Target,
        mut interface: RiscvCommunicationInterface<'probe>,
    ) -> Result<Core<'probe>, Error> {
        let name = &target.cores[self.id].name;

        let ResolvedCoreOptions::Riscv { options, sequence } = &self.core_state.core_access_options
        else {
            unreachable!(
                "The stored core state is not compatible with the RISC-V architecture. \
                This should never happen. Please file a bug if it does."
            );
        };
        let debug_sequence = sequence.clone();

        let SpecificCoreState::Riscv(s) = &mut self.specific_state else {
            unreachable!(
                "The stored core state is not compatible with the RISC-V architecture. \
                This should never happen. Please file a bug if it does."
            );
        };

        let hart = options.hart_id.unwrap_or_default();
        interface.select_hart(hart)?;

        Ok(Core::new(
            self.id,
            name,
            target,
            crate::architecture::riscv::Riscv32::new(interface, s, debug_sequence)?,
        ))
    }

    pub(crate) fn attach_xtensa<'probe>(
        &'probe mut self,
        target: &'probe Target,
        interface: XtensaCommunicationInterface<'probe>,
    ) -> Result<Core<'probe>, Error> {
        let name = &target.cores[self.id].name;

        let ResolvedCoreOptions::Xtensa { sequence, .. } = &self.core_state.core_access_options
        else {
            unreachable!(
                "The stored core state is not compatible with the Xtensa architecture. \
                This should never happen. Please file a bug if it does."
            );
        };
        let debug_sequence = sequence.clone();

        let SpecificCoreState::Xtensa(s) = &mut self.specific_state else {
            unreachable!(
                "The stored core state is not compatible with the Xtensa architecture. \
                This should never happen. Please file a bug if it does."
            );
        };

        Ok(Core::new(
            self.id,
            name,
            target,
            crate::architecture::xtensa::Xtensa::new(interface, s, debug_sequence)?,
        ))
    }

    /// Get the memory AP for this core.
    ///
    /// ## Panic
    ///
    /// This function will panic if the core is not an ARM core and doesn't have a memory AP
    pub(crate) fn arm_memory_ap(&self) -> FullyQualifiedApAddress {
        self.core_state.memory_ap()
    }
}

/// A generic core state which caches the generic parts of the core state.
#[derive(Debug)]
pub struct CoreState {
    /// Information needed to access the core
    core_access_options: ResolvedCoreOptions,
}

impl CoreState {
    /// Creates a new core state from the core ID.
    pub fn new(core_access_options: ResolvedCoreOptions) -> Self {
        Self {
            core_access_options,
        }
    }

    pub(crate) fn memory_ap(&self) -> FullyQualifiedApAddress {
        let ResolvedCoreOptions::Arm { options, .. } = &self.core_access_options else {
            unreachable!(
                "The stored core state is not compatible with the ARM architecture. \
                This should never happen. Please file a bug if it does."
            );
        };

        let dp = match options.targetsel {
            None => DpAddress::Default,
            Some(x) => DpAddress::Multidrop(x),
        };
        match &options.ap {
            probe_rs_target::ApAddress::V1(ap) => FullyQualifiedApAddress::v1_with_dp(dp, *ap),
            probe_rs_target::ApAddress::V2(ap) => {
                FullyQualifiedApAddress::v2_with_dp(dp, ApV2Address::new(*ap))
            }
        }
    }
}

/// The architecture specific core state.
#[derive(Debug)]
pub enum SpecificCoreState {
    /// The state of an ARMv6-M core.
    Armv6m(CortexMState),
    /// The state of an ARMv7-A core.
    Armv7a(CortexAState),
    /// The state of an ARMv7-M core.
    Armv7m(CortexMState),
    /// The state of an ARMv7-EM core.
    Armv7em(CortexMState),
    /// The state of an ARMv8-A core.
    Armv8a(CortexAState),
    /// The state of an ARMv8-M core.
    Armv8m(CortexMState),
    /// The state of an RISC-V core.
    Riscv(RiscvCoreState),
    /// The state of an Xtensa core.
    Xtensa(XtensaCoreState),
}

impl SpecificCoreState {
    pub(crate) fn from_core_type(typ: CoreType) -> Self {
        match typ {
            CoreType::Armv6m => SpecificCoreState::Armv6m(CortexMState::new()),
            CoreType::Armv7a => SpecificCoreState::Armv7a(CortexAState::new()),
            CoreType::Armv7m => SpecificCoreState::Armv7m(CortexMState::new()),
            CoreType::Armv7em => SpecificCoreState::Armv7m(CortexMState::new()),
            CoreType::Armv8a => SpecificCoreState::Armv8a(CortexAState::new()),
            CoreType::Armv8m => SpecificCoreState::Armv8m(CortexMState::new()),
            CoreType::Riscv => SpecificCoreState::Riscv(RiscvCoreState::new()),
            CoreType::Xtensa => SpecificCoreState::Xtensa(XtensaCoreState::new()),
        }
    }

    pub(crate) fn core_type(&self) -> CoreType {
        match self {
            SpecificCoreState::Armv6m(_) => CoreType::Armv6m,
            SpecificCoreState::Armv7a(_) => CoreType::Armv7a,
            SpecificCoreState::Armv7m(_) => CoreType::Armv7m,
            SpecificCoreState::Armv7em(_) => CoreType::Armv7em,
            SpecificCoreState::Armv8a(_) => CoreType::Armv8a,
            SpecificCoreState::Armv8m(_) => CoreType::Armv8m,
            SpecificCoreState::Riscv(_) => CoreType::Riscv,
            SpecificCoreState::Xtensa(_) => CoreType::Xtensa,
        }
    }
}