2e25b52c1212cd4ca1111916a25a5ceed535a26e
[fw/openocd] / src / target / arm9tdmi.h
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2008 by Spencer Oliver                                  *
6  *   spen@spen-soft.co.uk                                                  *
7  *                                                                         *
8  *   This program is free software; you can redistribute it and/or modify  *
9  *   it under the terms of the GNU General Public License as published by  *
10  *   the Free Software Foundation; either version 2 of the License, or     *
11  *   (at your option) any later version.                                   *
12  *                                                                         *
13  *   This program is distributed in the hope that it will be useful,       *
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16  *   GNU General Public License for more details.                          *
17  *                                                                         *
18  *   You should have received a copy of the GNU General Public License     *
19  *   along with this program; if not, write to the                         *
20  *   Free Software Foundation, Inc.,                                       *
21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
22  ***************************************************************************/
23 #ifndef ARM9TDMI_H
24 #define ARM9TDMI_H
25
26 #include "embeddedice.h"
27
28 /* FIXME we don't really need a separate arm9tdmi struct any more...
29  * remove it, the arm7/arm9 common struct suffices.
30  */
31 struct arm9tdmi_common
32 {
33         struct arm7_9_common arm7_9_common;
34 };
35
36 struct arm9tdmi_vector
37 {
38         char *name;
39         uint32_t value;
40 };
41
42 enum arm9tdmi_vector_bit
43 {
44         ARM9TDMI_RESET_VECTOR = 0x01,
45         ARM9TDMI_UNDEF_VECTOR = 0x02,
46         ARM9TDMI_SWI_VECTOR = 0x04,
47         ARM9TDMI_PABT_VECTOR = 0x08,
48         ARM9TDMI_DABT_VECTOR = 0x10,
49         /* BIT(5) reserved -- must be zero */
50         ARM9TDMI_IRQ_VECTOR = 0x40,
51         ARM9TDMI_FIQ_VECTOR = 0x80,
52 };
53
54 int arm9tdmi_init_target(struct command_context_s *cmd_ctx,
55                 struct target_s *target);
56 int arm9tdmi_examine(struct target_s *target);
57 int arm9tdmi_init_arch_info(target_t *target,
58                 struct arm9tdmi_common *arm9tdmi, struct jtag_tap *tap);
59 int arm9tdmi_register_commands(struct command_context_s *cmd_ctx);
60
61 int arm9tdmi_clock_out(struct arm_jtag *jtag_info,
62                 uint32_t instr, uint32_t out, uint32_t *in, int sysspeed);
63 int arm9tdmi_clock_data_in(struct arm_jtag *jtag_info, uint32_t *in);
64 int arm9tdmi_clock_data_in_endianness(struct arm_jtag *jtag_info,
65                 void *in, int size, int be);
66 void arm9tdmi_read_core_regs(target_t *target,
67                 uint32_t mask, uint32_t* core_regs[16]);
68 void arm9tdmi_write_core_regs(target_t *target,
69                 uint32_t mask, uint32_t core_regs[16]);
70
71 int arm9tdmi_examine_debug_reason(target_t *target);
72
73 void arm9tdmi_load_word_regs(target_t *target, uint32_t mask);
74 void arm9tdmi_load_hword_reg(target_t *target, int num);
75 void arm9tdmi_load_byte_reg(target_t *target, int num);
76 void arm9tdmi_store_word_regs(target_t *target, uint32_t mask);
77 void arm9tdmi_store_hword_reg(target_t *target, int num);
78 void arm9tdmi_store_byte_reg(target_t *target, int num);
79
80 void arm9tdmi_branch_resume(target_t *target);
81 void arm9tdmi_enable_single_step(target_t *target, uint32_t next_pc);
82 void arm9tdmi_disable_single_step(target_t *target);
83
84 #endif /* ARM9TDMI_H */