openocd: src/target: replace the GPL-2.0-or-later license tag
[fw/openocd] / src / target / arm11_dbgtap.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2
3 /***************************************************************************
4  *   Copyright (C) 2008 digenius technology GmbH.                          *
5  *   Michael Bruck                                                         *
6  *                                                                         *
7  *   Copyright (C) 2008,2009 Oyvind Harboe oyvind.harboe@zylin.com         *
8  ***************************************************************************/
9
10 #ifndef OPENOCD_TARGET_ARM11_DBGTAP_H
11 #define OPENOCD_TARGET_ARM11_DBGTAP_H
12
13 #include "arm11.h"
14
15 /* ARM11 internals */
16
17 void arm11_setup_field(struct arm11_common *arm11, int num_bits,
18                 void *in_data, void *out_data, struct scan_field *field);
19 void arm11_add_ir(struct arm11_common *arm11,
20                 uint8_t instr, tap_state_t state);
21 int arm11_add_debug_scan_n(struct arm11_common *arm11,
22                 uint8_t chain, tap_state_t state);
23 int arm11_read_dscr(struct arm11_common *arm11);
24 int arm11_write_dscr(struct arm11_common *arm11, uint32_t dscr);
25
26 int arm11_run_instr_data_prepare(struct arm11_common *arm11);
27 int arm11_run_instr_data_finish(struct arm11_common *arm11);
28 int arm11_run_instr_no_data1(struct arm11_common *arm11, uint32_t opcode);
29 int arm11_run_instr_data_to_core(struct arm11_common *arm11,
30                 uint32_t opcode, uint32_t *data, size_t count);
31 int arm11_run_instr_data_to_core_noack(struct arm11_common *arm11,
32                 uint32_t opcode, uint32_t *data, size_t count);
33 int arm11_run_instr_data_to_core1(struct arm11_common *arm11,
34                 uint32_t opcode, uint32_t data);
35 int arm11_run_instr_data_from_core(struct arm11_common *arm11,
36                 uint32_t opcode, uint32_t *data, size_t count);
37 int arm11_run_instr_data_from_core_via_r0(struct arm11_common *arm11,
38                 uint32_t opcode, uint32_t *data);
39 int arm11_run_instr_data_to_core_via_r0(struct arm11_common *arm11,
40                 uint32_t opcode, uint32_t data);
41
42 void arm11_add_dr_scan_vc(struct jtag_tap *tap, int num_fields, struct scan_field *fields,
43                 tap_state_t state);
44
45 /**
46  * Used with arm11_sc7_run to make a list of read/write commands for
47  * scan chain 7
48  */
49 struct arm11_sc7_action {
50         bool write;     /**< Access mode: true for write, false for read. */
51         uint8_t address;/**< Register address mode. Use enum #arm11_sc7 */
52         /**
53          * If write then set this to value to be written.  In read mode
54          * this receives the read value when the function returns.
55          */
56         uint32_t value;
57 };
58
59 int arm11_sc7_run(struct arm11_common *arm11,
60                 struct arm11_sc7_action *actions, size_t count);
61
62 /* Mid-level helper functions */
63 int arm11_sc7_clear_vbw(struct arm11_common *arm11);
64 int arm11_sc7_set_vcr(struct arm11_common *arm11, uint32_t value);
65
66 int arm11_read_memory_word(struct arm11_common *arm11,
67                 uint32_t address, uint32_t *result);
68
69 int arm11_dpm_init(struct arm11_common *arm11, uint32_t didr);
70 void arm11_dpm_deinit(struct arm11_common *arm11);
71 int arm11_bpwp_flush(struct arm11_common *arm11);
72
73 #endif /* OPENOCD_TARGET_ARM11_DBGTAP_H */