probe-rs 0.25.0

A collection of on chip debugging tools to communicate with microchips.
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
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

//! Contains helpers to build instructions for debugger use
pub(crate) mod aarch32 {
    /// Build a MOV instruction
    pub(crate) fn build_mov(rd: u16, rm: u16) -> u32 {
        let mut ret = 0b1110_0001_1010_0000_0000_0000_0000_0000;

        ret |= (rd as u32) << 12;
        ret |= rm as u32;

        ret
    }

    /// Build a MCR instruction
    pub(crate) fn build_mcr(
        coproc: u8,
        opcode1: u8,
        reg: u16,
        ctrl_reg_n: u8,
        ctrl_reg_m: u8,
        opcode2: u8,
    ) -> u32 {
        let mut ret = 0b1110_1110_0000_0000_0000_0000_0001_0000;

        ret |= (coproc as u32) << 8;
        ret |= (opcode1 as u32) << 21;
        ret |= (reg as u32) << 12;
        ret |= (ctrl_reg_n as u32) << 16;
        ret |= ctrl_reg_m as u32;
        ret |= (opcode2 as u32) << 5;

        ret
    }

    pub(crate) fn build_mrc(
        coproc: u8,
        opcode1: u8,
        reg: u16,
        ctrl_reg_n: u8,
        ctrl_reg_m: u8,
        opcode2: u8,
    ) -> u32 {
        let mut ret = 0b1110_1110_0001_0000_0000_0000_0001_0000;

        ret |= (coproc as u32) << 8;
        ret |= (opcode1 as u32) << 21;
        ret |= (reg as u32) << 12;
        ret |= (ctrl_reg_n as u32) << 16;
        ret |= ctrl_reg_m as u32;
        ret |= (opcode2 as u32) << 5;

        ret
    }

    pub(crate) fn build_bx(reg: u16) -> u32 {
        let mut ret = 0b1110_0001_0010_1111_1111_1111_0001_0000;

        ret |= reg as u32;

        ret
    }

    pub(crate) fn build_ldc(coproc: u8, ctrl_reg: u8, reg: u16, imm: u8) -> u32 {
        let mut ret = 0b1110_1100_1011_0000_0000_0000_0000_0000;

        ret |= (reg as u32) << 16;
        ret |= (ctrl_reg as u32) << 12;
        ret |= (coproc as u32) << 8;
        ret |= (imm as u32) >> 2;

        ret
    }

    pub(crate) fn build_stc(coproc: u8, ctrl_reg: u8, reg: u16, imm: u8) -> u32 {
        let mut ret = 0b1110_1100_1010_0000_0000_0000_0000_0000;

        ret |= (reg as u32) << 16;
        ret |= (ctrl_reg as u32) << 12;
        ret |= (coproc as u32) << 8;
        ret |= (imm as u32) >> 2;

        ret
    }

    pub(crate) fn build_mrs(reg: u16) -> u32 {
        let mut ret = 0b1110_0001_0000_1111_0000_0000_0000_0000;

        ret |= (reg as u32) << 12;

        ret
    }

    pub(crate) fn build_vmrs(reg_target: u16, ctrl_reg: u8) -> u32 {
        let mut ret = 0b1110_1110_1111_0000_0000_1010_0001_0000;

        ret |= (reg_target as u32) << 12;
        ret |= (ctrl_reg as u32) << 16;

        ret
    }

    pub(crate) fn build_vmov(op: u8, reg1: u16, reg2: u16, vreg: u16) -> u32 {
        let mut ret = 0b1110_1100_0100_0000_0000_1011_0001_0000;

        ret |= (op as u32) << 20;
        ret |= (reg2 as u32) << 16;
        ret |= (reg1 as u32) << 12;
        ret |= vreg as u32;

        ret
    }

    #[cfg(test)]
    mod tests {
        use super::*;

        #[test]
        fn gen_mcr_instruction() {
            let instr = build_mcr(14, 0, 2, 1, 2, 3);

            // MCR p14, 0, r2, c1, c2, 3
            assert_eq!(0xEE012E72, instr);
        }

        #[test]
        fn gen_mrc_instruction() {
            let instr = build_mrc(14, 0, 2, 1, 2, 3);

            // MRC p14, 0, r2, c1, c2, 3
            assert_eq!(0xEE112E72, instr);
        }

        #[test]
        fn gen_mov_instruction() {
            let instr = build_mov(2, 15);

            // MOV r2, pc
            assert_eq!(0xE1A0200F, instr);
        }

        #[test]
        fn gen_bx_instruction() {
            let instr = build_bx(2);

            // BX r2
            assert_eq!(0xE12FFF12, instr);
        }

        #[test]
        fn gen_ldc_instruction() {
            let instr = build_ldc(14, 5, 2, 4);

            // LDC p14, c5, [r2], #4
            assert_eq!(0xECB25E01, instr);
        }

        #[test]
        fn gen_stc_instruction() {
            let instr = build_stc(14, 5, 2, 4);

            // STC p14, c5, [r2], #4
            assert_eq!(0xECA25E01, instr);
        }

        #[test]
        fn gen_mrs_instruction() {
            let instr = build_mrs(2);

            // MRS r2, CPSR
            assert_eq!(0xE10F2000, instr);
        }

        #[test]
        fn gen_vmrs_instruction() {
            let instr = build_vmrs(2, 0b0111);

            // VMRS r2, MVFR0
            assert_eq!(0xEEF72A10, instr);
        }

        #[test]
        fn gen_vmov_instruction() {
            let instr = build_vmov(1, 1, 2, 3);

            // VMOV r1, r2, d3
            assert_eq!(0xEC521B13, instr);
        }
    }
}

pub(crate) mod thumb2 {
    // These are the same encoding in thumb2
    pub(crate) use super::aarch32::{build_mcr, build_mrc, build_vmov, build_vmrs};

    pub(crate) fn build_ldr(reg_target: u16, reg_source: u16, imm: u8) -> u32 {
        let mut ret = 0b1111_1000_0101_0000_0000_1011_0000_0000;

        ret |= (reg_source as u32) << 16;
        ret |= (reg_target as u32) << 12;
        ret |= imm as u32;

        ret
    }

    pub(crate) fn build_str(reg_target: u16, reg_source: u16, imm: u8) -> u32 {
        let mut ret = 0b1111_1000_0100_0000_0000_1011_0000_0000;

        ret |= (reg_source as u32) << 16;
        ret |= (reg_target as u32) << 12;
        ret |= imm as u32;

        ret
    }

    #[cfg(test)]
    mod tests {
        use super::*;

        #[test]
        fn gen_ldr_instruction() {
            let instr = build_ldr(2, 3, 4);

            // LDR r2, [r3], #4
            assert_eq!(0xF8532B04, instr);
        }

        #[test]
        fn gen_str_instruction() {
            let instr = build_str(2, 3, 4);

            // STR r2, [r3], #4
            assert_eq!(0xF8432B04, instr);
        }
    }
}

pub(crate) mod aarch64 {
    pub(crate) fn build_ldr(reg_target: u16, reg_source: u16, imm: u16) -> u32 {
        let mut ret = 0b1111_1000_0100_0000_0000_0100_0000_0000;

        ret |= (imm as u32) << 12;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    pub(crate) fn build_ldrw(reg_target: u16, reg_source: u16, imm: u16) -> u32 {
        let mut ret = 0b1011_1000_0100_0000_0000_0100_0000_0000;

        ret |= (imm as u32) << 12;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    pub(crate) fn build_ldrb(reg_target: u16, reg_source: u16, imm: u16) -> u32 {
        let mut ret = 0b0011_1000_0100_0000_0000_0100_0000_0000;

        ret |= (imm as u32) << 12;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    pub(crate) fn build_mrs(op0: u8, op1: u8, crn: u8, crm: u8, op2: u8, reg: u16) -> u32 {
        let mut ret = 0b1101_0101_0011_0000_0000_0000_0000_0000;

        ret |= (op0 as u32) << 19;
        ret |= (op1 as u32) << 16;
        ret |= (crn as u32) << 12;
        ret |= (crm as u32) << 8;
        ret |= (op2 as u32) << 5;
        ret |= reg as u32;

        ret
    }

    pub(crate) fn build_msr(op0: u8, op1: u8, crn: u8, crm: u8, op2: u8, reg: u16) -> u32 {
        let mut ret = 0b1101_0101_0001_0000_0000_0000_0000_0000;

        ret |= (op0 as u32) << 19;
        ret |= (op1 as u32) << 16;
        ret |= (crn as u32) << 12;
        ret |= (crm as u32) << 8;
        ret |= (op2 as u32) << 5;
        ret |= reg as u32;

        ret
    }

    pub(crate) fn build_str(reg_target: u16, reg_source: u16, imm: u16) -> u32 {
        let mut ret = 0b1111_1000_0000_0000_0000_0100_0000_0000;

        ret |= (imm as u32) << 12;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    pub(crate) fn build_strw(reg_target: u16, reg_source: u16, imm: u16) -> u32 {
        let mut ret = 0b1011_1000_0000_0000_0000_0100_0000_0000;

        ret |= (imm as u32) << 12;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    pub(crate) fn build_strb(reg_target: u16, reg_source: u16, imm: u16) -> u32 {
        let mut ret = 0b0011_1000_0000_0000_0000_0100_0000_0000;

        ret |= (imm as u32) << 12;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    pub(crate) fn build_ins_fp_to_gp(reg_target: u16, reg_source: u16, index: u16) -> u32 {
        let mut ret = 0b0100_1110_0000_1000_0011_1100_0000_0000;

        ret |= (index as u32) << 20;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    pub(crate) fn build_ins_gp_to_fp(reg_target: u16, reg_source: u16, index: u16) -> u32 {
        let mut ret = 0b0100_1110_0000_1000_0001_1100_0000_0000;

        ret |= (index as u32) << 20;
        ret |= (reg_source as u32) << 5;
        ret |= reg_target as u32;

        ret
    }

    #[cfg(test)]
    mod tests {
        use super::*;
        #[test]
        fn gen_ldr_instruction() {
            let instr = build_ldr(2, 3, 4);

            // LDR x2, [x3], #4
            assert_eq!(0xF8404462, instr);
        }

        #[test]
        fn gen_ldrw_instruction() {
            let instr = build_ldrw(2, 3, 4);

            // LDR w2, [x3], #4
            assert_eq!(0xB8404462, instr);
        }

        #[test]
        fn gen_msr_instruction() {
            let instr = build_msr(2, 3, 4, 1, 2, 3);

            // MSR x3, s3_3_c4_c1_2
            assert_eq!(0xD5134143, instr);
        }

        #[test]
        fn gen_mrs_instruction() {
            let instr = build_mrs(2, 3, 4, 1, 2, 3);

            // MRS x3, s3_3_c4_c1_2
            assert_eq!(0xD5334143, instr);
        }

        #[test]
        fn gen_str_instruction() {
            let instr = build_str(2, 3, 4);

            // STR x2, [x3], #4
            assert_eq!(0xF8004462, instr);
        }

        #[test]
        fn gen_strw_instruction() {
            let instr = build_strw(2, 3, 4);

            // STR w2, [x3], #4
            assert_eq!(0xB8004462, instr);
        }

        #[test]
        fn gen_ins_gp_to_fp_instruction() {
            let instr = build_ins_gp_to_fp(3, 2, 1);

            // INS v3.d[1], x2
            assert_eq!(0x4E181C43, instr);
        }

        #[test]
        fn gen_ins_fp_to_gp_instruction() {
            let instr = build_ins_fp_to_gp(3, 2, 1);

            // MOV x3, v2.d[1]
            assert_eq!(0x4E183C43, instr);
        }
    }
}