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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
use super::{
ap::{
valid_access_ports, AccessPort, ApAccess, ApClass, BaseaddrFormat, GenericAp, MemoryAp,
BASE, BASE2, CFG, CSW, IDR,
},
dp::{Abort, Ctrl, DebugPortVersion, DpAccess, Select, DPIDR},
memory::{
adi_v5_memory_interface::{ADIMemoryInterface, ArmProbe},
Component,
},
sequences::{ArmDebugSequence, DefaultArmSequence},
ApAddress, ArmError, DapAccess, DpAddress, PortType, RawDapAccess, SwoAccess, SwoConfig,
};
use crate::{
architecture::arm::ap::DataSize, DebugProbe, DebugProbeError, Error as ProbeRsError, Probe,
};
use jep106::JEP106Code;
use std::{
collections::{hash_map, HashMap},
fmt::Debug,
sync::Arc,
time::Duration,
};
#[derive(Debug, thiserror::Error, Clone, PartialEq, Eq)]
pub enum DapError {
#[error("An error occurred in the SWD communication between probe and device.")]
SwdProtocol,
#[error("Target device did not respond to request.")]
NoAcknowledge,
#[error("Target device responded with a FAULT response to the request.")]
FaultResponse,
#[error("Target device responded with a WAIT response to the request.")]
WaitResponse,
#[error("Incorrect parity on READ request.")]
IncorrectParity,
}
pub trait Register:
Clone + TryFrom<u32, Error = RegisterParseError> + Into<u32> + Sized + Debug
{
const ADDRESS: u8;
const NAME: &'static str;
}
#[derive(Debug, thiserror::Error)]
#[error("Failed to parse register {name} from {value:#010x}")]
pub struct RegisterParseError {
name: &'static str,
value: u32,
}
impl RegisterParseError {
pub fn new(name: &'static str, value: u32) -> Self {
RegisterParseError { name, value }
}
}
pub trait ArmProbeInterface: DapAccess + SwdSequence + SwoAccess + Send {
fn memory_interface(
&mut self,
access_port: MemoryAp,
) -> Result<Box<dyn ArmProbe + '_>, ArmError>;
fn ap_information(&mut self, access_port: GenericAp) -> Result<&ApInformation, ArmError>;
fn num_access_ports(&mut self, dp: DpAddress) -> Result<usize, ArmError>;
fn read_chip_info_from_rom_table(
&mut self,
dp: DpAddress,
) -> Result<Option<ArmChipInfo>, ArmError>;
fn close(self: Box<Self>) -> Probe;
}
pub trait SwdSequence {
fn swj_sequence(&mut self, bit_len: u8, bits: u64) -> Result<(), DebugProbeError>;
fn swj_pins(
&mut self,
pin_out: u32,
pin_select: u32,
pin_wait: u32,
) -> Result<u32, DebugProbeError>;
}
pub trait UninitializedArmProbe: SwdSequence + Debug {
fn initialize(
self: Box<Self>,
sequence: Arc<dyn ArmDebugSequence>,
) -> Result<Box<dyn ArmProbeInterface>, (Box<dyn UninitializedArmProbe>, ProbeRsError)>;
fn initialize_unspecified(
self: Box<Self>,
) -> Result<Box<dyn ArmProbeInterface>, (Box<dyn UninitializedArmProbe>, ProbeRsError)> {
self.initialize(DefaultArmSequence::create())
}
fn close(self: Box<Self>) -> Probe;
}
pub trait ArmDebugState {}
#[derive(Debug)]
pub struct Uninitialized {
pub(crate) use_overrun_detect: bool,
}
pub struct Initialized {
current_dp: Option<DpAddress>,
dps: HashMap<DpAddress, DpState>,
use_overrun_detect: bool,
sequence: Arc<dyn ArmDebugSequence>,
}
impl Initialized {
pub fn new(sequence: Arc<dyn ArmDebugSequence>, use_overrun_detect: bool) -> Self {
Self {
current_dp: None,
dps: HashMap::new(),
use_overrun_detect,
sequence,
}
}
}
impl ArmDebugState for Uninitialized {}
impl ArmDebugState for Initialized {}
#[derive(Debug)]
pub(crate) struct DpState {
pub _debug_port_version: DebugPortVersion,
pub current_dpbanksel: u8,
pub current_apsel: u8,
pub current_apbanksel: u8,
pub ap_information: Vec<ApInformation>,
}
impl DpState {
pub fn new() -> Self {
Self {
_debug_port_version: DebugPortVersion::Unsupported(0xFF),
current_dpbanksel: 0,
current_apsel: 0,
current_apbanksel: 0,
ap_information: Vec::new(),
}
}
}
#[derive(Clone, Debug)]
pub enum ApInformation {
MemoryAp(MemoryApInformation),
Other {
address: ApAddress,
idr: IDR,
},
}
impl ApInformation {
pub(crate) fn read_from_target<P>(
probe: &mut P,
access_port: GenericAp,
) -> Result<Self, ArmError>
where
P: ApAccess,
{
let idr: IDR = probe.read_ap_register(access_port)?;
if idr.CLASS == ApClass::MemAp {
let access_port: MemoryAp = access_port.into();
let base_register: BASE = probe.read_ap_register(access_port)?;
let mut base_address = if BaseaddrFormat::ADIv5 == base_register.Format {
let base2: BASE2 = probe.read_ap_register(access_port)?;
u64::from(base2.BASEADDR) << 32
} else {
0
};
base_address |= u64::from(base_register.BASEADDR << 12);
let old_csw: CSW = probe.read_ap_register(access_port)?;
let csw = CSW::new(DataSize::U8);
probe.write_ap_register(access_port, csw)?;
let csw: CSW = probe.read_ap_register(access_port)?;
probe.write_ap_register(access_port, old_csw)?;
let only_32bit_data_size = csw.SIZE != DataSize::U8;
let supports_hnonsec = csw.HNONSEC == 1;
tracing::debug!("HNONSEC supported: {}", supports_hnonsec);
let device_enabled = csw.DeviceEn == 1;
tracing::debug!("Device enabled: {}", device_enabled);
let cfg: CFG = probe.read_ap_register(access_port)?;
let has_large_address_extension = cfg.LA == 1;
let has_large_data_extension = cfg.LD == 1;
Ok(ApInformation::MemoryAp(MemoryApInformation {
address: access_port.ap_address(),
supports_only_32bit_data_size: only_32bit_data_size,
debug_base_address: base_address,
supports_hnonsec,
has_large_address_extension,
has_large_data_extension,
device_enabled,
}))
} else {
Ok(ApInformation::Other {
address: access_port.ap_address(),
idr,
})
}
}
}
#[derive(Debug, Clone)]
pub struct MemoryApInformation {
pub address: ApAddress,
pub supports_only_32bit_data_size: bool,
pub debug_base_address: u64,
pub supports_hnonsec: bool,
pub has_large_address_extension: bool,
pub has_large_data_extension: bool,
pub device_enabled: bool,
}
#[derive(Debug)]
pub struct ArmCommunicationInterface<S: ArmDebugState> {
probe: Box<dyn DapProbe>,
state: S,
}
pub trait DapProbe: RawDapAccess + DebugProbe {}
impl ArmProbeInterface for ArmCommunicationInterface<Initialized> {
fn memory_interface(
&mut self,
access_port: MemoryAp,
) -> Result<Box<dyn ArmProbe + '_>, ArmError> {
ArmCommunicationInterface::memory_interface(self, access_port)
}
fn ap_information(&mut self, access_port: GenericAp) -> Result<&ApInformation, ArmError> {
let info = ArmCommunicationInterface::ap_information(self, access_port)?;
info.ok_or_else(|| ArmError::ApDoesNotExist(access_port.ap_address()))
}
fn read_chip_info_from_rom_table(
&mut self,
dp: DpAddress,
) -> Result<Option<ArmChipInfo>, ArmError> {
ArmCommunicationInterface::read_chip_info_from_rom_table(self, dp)
}
fn num_access_ports(&mut self, dp: DpAddress) -> Result<usize, ArmError> {
ArmCommunicationInterface::num_access_ports(self, dp)
}
fn close(self: Box<Self>) -> Probe {
Probe::from_attached_probe(RawDapAccess::into_probe(self.probe))
}
}
impl<S: ArmDebugState> SwdSequence for ArmCommunicationInterface<S> {
fn swj_sequence(&mut self, bit_len: u8, bits: u64) -> Result<(), DebugProbeError> {
self.probe.swj_sequence(bit_len, bits)?;
Ok(())
}
fn swj_pins(
&mut self,
pin_out: u32,
pin_select: u32,
pin_wait: u32,
) -> Result<u32, DebugProbeError> {
self.probe.swj_pins(pin_out, pin_select, pin_wait)
}
}
impl ArmCommunicationInterface<Uninitialized> {
pub(crate) fn new(probe: Box<dyn DapProbe>, use_overrun_detect: bool) -> Self {
let state = Uninitialized { use_overrun_detect };
Self { probe, state }
}
fn into_initialized(
self,
sequence: Arc<dyn ArmDebugSequence>,
) -> Result<ArmCommunicationInterface<Initialized>, (Box<Self>, DebugProbeError)> {
let use_overrun_detect = self.state.use_overrun_detect;
ArmCommunicationInterface::<Initialized>::from_uninitialized(
self,
sequence,
use_overrun_detect,
)
}
}
impl UninitializedArmProbe for ArmCommunicationInterface<Uninitialized> {
fn initialize(
mut self: Box<Self>,
sequence: Arc<dyn ArmDebugSequence>,
) -> Result<Box<dyn ArmProbeInterface>, (Box<dyn UninitializedArmProbe>, ProbeRsError)> {
let setup_span = tracing::debug_span!("debug_port_setup").entered();
if let Err(e) = sequence.debug_port_setup(&mut *self.probe) {
return Err((self as Box<_>, e.into()));
}
drop(setup_span);
let interface = self
.into_initialized(sequence)
.map_err(|(s, err)| (s as Box<_>, ProbeRsError::Probe(err)))?;
Ok(Box::new(interface))
}
fn close(self: Box<Self>) -> Probe {
Probe::from_attached_probe(RawDapAccess::into_probe(self.probe))
}
}
impl<S: ArmDebugState> ArmCommunicationInterface<S> {
fn _get_debug_port_version(&mut self) -> Result<DebugPortVersion, ArmError> {
let dpidr = DPIDR(self.probe.raw_read_register(PortType::DebugPort, 0)?);
Ok(DebugPortVersion::from(dpidr.version()))
}
}
impl<'interface> ArmCommunicationInterface<Initialized> {
fn from_uninitialized(
interface: ArmCommunicationInterface<Uninitialized>,
sequence: Arc<dyn ArmDebugSequence>,
use_overrun_detect: bool,
) -> Result<
Self,
(
Box<ArmCommunicationInterface<Uninitialized>>,
DebugProbeError,
),
> {
let initialized_interface = ArmCommunicationInterface {
probe: interface.probe,
state: Initialized::new(sequence, use_overrun_detect),
};
Ok(initialized_interface)
}
pub fn memory_interface(
&'interface mut self,
access_port: MemoryAp,
) -> Result<Box<dyn ArmProbe + 'interface>, ArmError> {
let info = self
.ap_information(access_port)?
.ok_or_else(|| ArmError::ApDoesNotExist(access_port.ap_address()))?;
match info {
ApInformation::MemoryAp(ap_information) => {
let information = ap_information.clone();
let adi_v5_memory_interface = ADIMemoryInterface::<
'interface,
ArmCommunicationInterface<Initialized>,
>::new(self, information)
.map_err(|e| ArmError::from_access_port(e, access_port))?;
Ok(Box::new(adi_v5_memory_interface))
}
ApInformation::Other { .. } => Err(ArmError::WrongApType),
}
}
fn select_dp(&mut self, dp: DpAddress) -> Result<&mut DpState, ArmError> {
if self.state.current_dp == Some(dp) {
return Ok(self.state.dps.get_mut(&dp).unwrap());
}
tracing::debug!("Selecting DP {:x?}", dp);
if let Err(e) = self.probe.select_dp(dp) {
self.state.current_dp = None;
return Err(e);
}
self.state.current_dp = Some(dp);
if let hash_map::Entry::Vacant(entry) = self.state.dps.entry(dp) {
let sequence = self.state.sequence.clone();
entry.insert(DpState::new());
let start_span = tracing::debug_span!("debug_port_start").entered();
sequence.debug_port_start(self, dp)?;
drop(start_span);
tracing::debug!("Setting orun_detect: {}", self.state.use_overrun_detect);
let mut ctrl_reg: Ctrl = self.read_dp_register(dp)?;
ctrl_reg.set_orun_detect(self.state.use_overrun_detect);
self.write_dp_register(dp, ctrl_reg)?;
tracing::trace!("Searching valid APs");
let ap_span = tracing::debug_span!("AP discovery").entered();
for ap in valid_access_ports(self, dp) {
let ap_state = ApInformation::read_from_target(self, ap)?;
tracing::debug!("AP {:x?}: {:?}", ap, ap_state);
let state = self.state.dps.get_mut(&dp).unwrap();
state.ap_information.push(ap_state);
}
drop(ap_span);
}
Ok(self.state.dps.get_mut(&dp).unwrap())
}
fn select_dp_and_dp_bank(
&mut self,
dp: DpAddress,
dp_register_address: u8,
) -> Result<(), ArmError> {
let dp_state = self.select_dp(dp)?;
let bank = dp_register_address >> 4;
let addr = dp_register_address & 0xF;
if addr != 4 {
return Ok(());
}
if bank != dp_state.current_dpbanksel {
dp_state.current_dpbanksel = bank;
let mut select = Select(0);
tracing::debug!("Changing DP_BANK_SEL to {}", dp_state.current_dpbanksel);
select.set_ap_sel(dp_state.current_apsel);
select.set_ap_bank_sel(dp_state.current_apbanksel);
select.set_dp_bank_sel(dp_state.current_dpbanksel);
self.write_dp_register(dp, select)?;
}
Ok(())
}
fn select_ap_and_ap_bank(
&mut self,
ap: ApAddress,
ap_register_address: u8,
) -> Result<(), ArmError> {
let dp_state = self.select_dp(ap.dp)?;
let port = ap.ap;
let ap_bank = ap_register_address >> 4;
let mut cache_changed = if dp_state.current_apsel != port {
dp_state.current_apsel = port;
true
} else {
false
};
if dp_state.current_apbanksel != ap_bank {
dp_state.current_apbanksel = ap_bank;
cache_changed = true;
}
if cache_changed {
let mut select = Select(0);
tracing::debug!(
"Changing AP to {}, AP_BANK_SEL to {}",
dp_state.current_apsel,
dp_state.current_apbanksel
);
select.set_ap_sel(dp_state.current_apsel);
select.set_ap_bank_sel(dp_state.current_apbanksel);
select.set_dp_bank_sel(dp_state.current_dpbanksel);
self.write_dp_register(ap.dp, select)?;
}
Ok(())
}
pub(crate) fn ap_information(
&mut self,
access_port: impl AccessPort,
) -> Result<Option<&ApInformation>, ArmError> {
let addr = access_port.ap_address();
let state = self.select_dp(addr.dp)?;
Ok(state.ap_information.get(addr.ap as usize))
}
fn num_access_ports(&mut self, dp: DpAddress) -> Result<usize, ArmError> {
let state = self.select_dp(dp)?;
Ok(state.ap_information.len())
}
}
impl FlushableArmAccess for ArmCommunicationInterface<Initialized> {
fn flush(&mut self) -> Result<(), ArmError> {
self.probe.raw_flush()
}
fn get_arm_communication_interface(
&mut self,
) -> Result<&mut ArmCommunicationInterface<Initialized>, DebugProbeError> {
Ok(self)
}
}
impl SwoAccess for ArmCommunicationInterface<Initialized> {
fn enable_swo(&mut self, config: &SwoConfig) -> Result<(), ArmError> {
match self.probe.get_swo_interface_mut() {
Some(interface) => interface.enable_swo(config),
None => Err(ArmError::ArchitectureRequired(&["ARMv7", "ARMv8"])),
}
}
fn disable_swo(&mut self) -> Result<(), ArmError> {
match self.probe.get_swo_interface_mut() {
Some(interface) => interface.disable_swo(),
None => Err(ArmError::ArchitectureRequired(&["ARMv7", "ARMv8"])),
}
}
fn read_swo_timeout(&mut self, timeout: Duration) -> Result<Vec<u8>, ArmError> {
match self.probe.get_swo_interface_mut() {
Some(interface) => interface.read_swo_timeout(timeout),
None => Err(ArmError::ArchitectureRequired(&["ARMv7", "ARMv8"])),
}
}
}
impl DapAccess for ArmCommunicationInterface<Initialized> {
fn read_raw_dp_register(&mut self, dp: DpAddress, address: u8) -> Result<u32, ArmError> {
self.select_dp_and_dp_bank(dp, address)?;
let result = self.probe.raw_read_register(PortType::DebugPort, address)?;
Ok(result)
}
fn write_raw_dp_register(
&mut self,
dp: DpAddress,
address: u8,
value: u32,
) -> Result<(), ArmError> {
self.select_dp_and_dp_bank(dp, address)?;
self.probe
.raw_write_register(PortType::DebugPort, address, value)?;
Ok(())
}
fn read_raw_ap_register(
&mut self,
ap: ApAddress,
address: u8,
) -> std::result::Result<u32, ArmError> {
self.select_ap_and_ap_bank(ap, address)?;
let result = self
.probe
.raw_read_register(PortType::AccessPort, address)?;
Ok(result)
}
fn read_raw_ap_register_repeated(
&mut self,
ap: ApAddress,
address: u8,
values: &mut [u32],
) -> Result<(), ArmError> {
self.select_ap_and_ap_bank(ap, address)?;
self.probe
.raw_read_block(PortType::AccessPort, address, values)?;
Ok(())
}
fn write_raw_ap_register(
&mut self,
ap: ApAddress,
address: u8,
value: u32,
) -> Result<(), ArmError> {
self.select_ap_and_ap_bank(ap, address)?;
self.probe
.raw_write_register(PortType::AccessPort, address, value)?;
Ok(())
}
fn write_raw_ap_register_repeated(
&mut self,
ap: ApAddress,
address: u8,
values: &[u32],
) -> Result<(), ArmError> {
self.select_ap_and_ap_bank(ap, address)?;
self.probe
.raw_write_block(PortType::AccessPort, address, values)?;
Ok(())
}
}
#[derive(Debug)]
pub struct ArmChipInfo {
pub manufacturer: JEP106Code,
pub part: u16,
}
impl ArmCommunicationInterface<Initialized> {
pub fn read_chip_info_from_rom_table(
&mut self,
dp: DpAddress,
) -> Result<Option<ArmChipInfo>, ArmError> {
let aps = valid_access_ports(self, dp);
let ctrl_reg: crate::architecture::arm::dp::Ctrl = self.read_dp_register(dp)?;
if ctrl_reg.sticky_err() {
tracing::trace!("AP Search faulted. Cleaning up");
let mut abort = Abort::default();
abort.set_stkerrclr(true);
self.write_dp_register(dp, abort)?;
}
for access_port in aps {
let idr: IDR = self.read_ap_register(access_port)?;
tracing::debug!("{:#x?}", idr);
if idr.CLASS == ApClass::MemAp {
let access_port: MemoryAp = access_port.into();
let baseaddr = access_port.base_address(self)?;
let mut memory = self.memory_interface(access_port)?;
let component = Component::try_parse(&mut *memory, baseaddr)?;
if let Component::Class1RomTable(component_id, _) = component {
if let Some(jep106) = component_id.peripheral_id().jep106() {
return Ok(Some(ArmChipInfo {
manufacturer: jep106,
part: component_id.peripheral_id().part(),
}));
}
}
}
}
Ok(None)
}
}
impl std::fmt::Display for ArmChipInfo {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let manu = match self.manufacturer.get() {
Some(name) => name.to_string(),
None => format!(
"<unknown manufacturer (cc={:2x}, id={:2x})>",
self.manufacturer.cc, self.manufacturer.id
),
};
write!(f, "{} 0x{:04x}", manu, self.part)
}
}
pub trait FlushableArmAccess {
fn flush(&mut self) -> Result<(), ArmError>;
fn get_arm_communication_interface(
&mut self,
) -> Result<&mut ArmCommunicationInterface<Initialized>, DebugProbeError>;
}