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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
use crate::{
probe::{DebugProbe, DebugProbeError},
CoreStatus,
};
use super::ArmError;
/// The type of port we are using.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum PortType {
/// Debug Port (e.g. SWD or JTAG)
DebugPort,
/// Access Port (e.g. Memory Access Port)
AccessPort,
}
bitfield::bitfield! {
/// A struct to describe the default CMSIS-DAP pins that one can toggle from the host.
#[derive(Copy, Clone)]
pub struct Pins(u8);
impl Debug;
/// The active low reset of the debug probe.
pub nreset, set_nreset: 7;
/// The negative target reset pin of JTAG.
pub ntrst, set_ntrst: 5;
/// The TDO or SWO pin.
pub tdo, set_tdo: 3;
/// The TDI pin.
pub tdi, set_tdi: 2;
/// The SWDIO or TMS pin.
pub swdio_tms, set_swdio_tms: 1;
/// The clock pin.
pub swclk_tck, set_swclk_tck: 0;
}
/// Debug port address.
#[derive(Debug, Eq, PartialEq, Clone, Copy, Hash, Default)]
pub enum DpAddress {
/// Access the single DP on the bus, assuming there is only one.
/// Will cause corruption if multiple are present.
#[default]
Default,
/// Select a particular DP on a SWDv2 multidrop bus. The contained `u32` is
/// the `TARGETSEL` value to select it.
Multidrop(u32),
}
/// Access port address.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct ApAddress {
/// The address of the debug port this access port belongs to.
pub dp: DpAddress,
/// The access port number.
pub ap: u8,
}
impl ApAddress {
/// Create a new `ApAddress` belonging to the default debug port.
pub fn with_default_dp(ap: u8) -> Self {
Self {
dp: DpAddress::Default,
ap,
}
}
}
/// Low-level DAP register access.
///
/// Operations on this trait closely match the transactions on the wire. Implementors
/// only do basic error handling, such as retrying WAIT errors.
///
/// Almost everything is the responsibility of the caller. For example, the caller must
/// handle bank switching and AP selection.
pub trait RawDapAccess {
/// Read a DAP register.
///
/// Only the lowest 4 bits of `addr` are used. Bank switching is the caller's responsibility.
fn raw_read_register(&mut self, port: PortType, addr: u8) -> Result<u32, ArmError>;
/// Read multiple values from the same DAP register.
///
/// If possible, this uses optimized read functions, otherwise it
/// falls back to the `read_register` function.
///
/// Only the lowest 4 bits of `addr` are used. Bank switching is the caller's responsibility.
fn raw_read_block(
&mut self,
port: PortType,
addr: u8,
values: &mut [u32],
) -> Result<(), ArmError> {
for val in values {
*val = self.raw_read_register(port, addr)?;
}
Ok(())
}
/// Write a value to a DAP register.
///
/// Only the lowest 4 bits of `addr` are used. Bank switching is the caller's responsibility.
fn raw_write_register(&mut self, port: PortType, addr: u8, value: u32) -> Result<(), ArmError>;
/// Write multiple values to the same DAP register.
///
/// If possible, this uses optimized write functions, otherwise it
/// falls back to the `write_register` function.
///
/// Only the lowest 4 bits of `addr` are used. Bank switching is the caller's responsibility.
fn raw_write_block(
&mut self,
port: PortType,
addr: u8,
values: &[u32],
) -> Result<(), ArmError> {
for val in values {
self.raw_write_register(port, addr, *val)?;
}
Ok(())
}
/// Flush any outstanding writes.
///
/// By default, this does nothing -- but in probes that implement write
/// batching, this needs to flush any pending writes.
fn raw_flush(&mut self) -> Result<(), ArmError> {
Ok(())
}
/// Configures the probe for JTAG use (specifying IR lengths of each DAP).
fn configure_jtag(&mut self) -> Result<(), DebugProbeError> {
Ok(())
}
/// Send a specific output sequence over JTAG.
///
/// This can only be used for output, and should be used to generate
/// the initial reset sequence, for example.
fn jtag_sequence(&mut self, cycles: u8, tms: bool, tdi: u64) -> Result<(), DebugProbeError>;
/// Send a specific output sequence over JTAG or SWD.
///
/// This can only be used for output, and should be used to generate
/// the initial reset sequence, for example.
fn swj_sequence(&mut self, bit_len: u8, bits: u64) -> Result<(), DebugProbeError>;
/// Set the state of debugger output pins directly.
///
/// The bits have the following meaning:
///
/// Bit 0: SWCLK/TCK
/// Bit 1: SWDIO/TMS
/// Bit 2: TDI
/// Bit 3: TDO
/// Bit 5: nTRST
/// Bit 7: nRESET
fn swj_pins(
&mut self,
pin_out: u32,
pin_select: u32,
pin_wait: u32,
) -> Result<u32, DebugProbeError>;
/// Cast this interface into a generic [`DebugProbe`].
fn into_probe(self: Box<Self>) -> Box<dyn DebugProbe>;
/// Inform the probe of the [`CoreStatus`] of the chip attached to the probe.
fn core_status_notification(&mut self, state: CoreStatus) -> Result<(), DebugProbeError>;
}
/// High-level DAP register access.
///
/// Operations on this trait perform logical register reads/writes. Implementations
/// are responsible for bank switching and AP selection, so one method call can result
/// in multiple transactions on the wire, if necessary.
pub trait DapAccess {
/// Read a Debug Port register.
///
/// Highest 4 bits of `addr` are interpreted as the bank number, implementations
/// will do bank switching if necessary.
///
/// If the device uses multiple debug ports, this will switch the active debug port if necessary.
/// In case this happens, all queued operations will be performed, and returned errors can be from
/// these operations as well.
fn read_raw_dp_register(&mut self, dp: DpAddress, addr: u8) -> Result<u32, ArmError>;
/// Write a Debug Port register.
///
/// Highest 4 bits of `addr` are interpreted as the bank number, implementations
/// will do bank switching if necessary.
///
/// If the device uses multiple debug ports, this will switch the active debug port if necessary.
/// In case this happens, all queued operations will be performed, and returned errors can be from
/// these operations as well.
fn write_raw_dp_register(
&mut self,
dp: DpAddress,
addr: u8,
value: u32,
) -> Result<(), ArmError>;
/// Read an Access Port register.
///
/// Highest 4 bits of `addr` are interpreted as the bank number, implementations
/// will do bank switching if necessary.
fn read_raw_ap_register(&mut self, ap: ApAddress, addr: u8) -> Result<u32, ArmError>;
/// Read multiple values from the same Access Port register.
///
/// If possible, this uses optimized read functions, otherwise it
/// falls back to the `read_raw_ap_register` function.
///
/// Highest 4 bits of `addr` are interpreted as the bank number, implementations
/// will do bank switching if necessary.
fn read_raw_ap_register_repeated(
&mut self,
ap: ApAddress,
addr: u8,
values: &mut [u32],
) -> Result<(), ArmError> {
for val in values {
*val = self.read_raw_ap_register(ap, addr)?;
}
Ok(())
}
/// Write an AP register.
///
/// Highest 4 bits of `addr` are interpreted as the bank number, implementations
/// will do bank switching if necessary.
fn write_raw_ap_register(
&mut self,
ap: ApAddress,
addr: u8,
value: u32,
) -> Result<(), ArmError>;
/// Write multiple values to the same Access Port register.
///
/// If possible, this uses optimized write functions, otherwise it
/// falls back to the `write_raw_ap_register` function.
///
/// Highest 4 bits of `addr` are interpreted as the bank number, implementations
/// will do bank switching if necessary.
fn write_raw_ap_register_repeated(
&mut self,
ap: ApAddress,
addr: u8,
values: &[u32],
) -> Result<(), ArmError> {
for val in values {
self.write_raw_ap_register(ap, addr, *val)?;
}
Ok(())
}
}