Andreas Fritiofson <andreas.fritiofson@gmail.com> UTF8 fixes
[fw/openocd] / src / target / xscale.h
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
6  *   oyvind.harboe@zylin.com                                               *
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 XSCALE_H
24 #define XSCALE_H
25
26 #include "armv4_5.h"
27 #include "armv4_5_mmu.h"
28 #include "trace.h"
29
30 #define XSCALE_COMMON_MAGIC 0x58534341
31
32 typedef struct xscale_jtag_s
33 {
34         /* position in JTAG scan chain */
35         jtag_tap_t *tap;
36
37         /* IR length and instructions */
38         int ir_length;
39         uint32_t dbgrx;
40         uint32_t dbgtx;
41         uint32_t ldic;
42         uint32_t dcsr;
43 } xscale_jtag_t;
44
45 enum xscale_debug_reason
46 {
47         XSCALE_DBG_REASON_GENERIC,
48         XSCALE_DBG_REASON_RESET,
49         XSCALE_DBG_REASON_TB_FULL,
50 };
51
52 enum xscale_trace_entry_type
53 {
54         XSCALE_TRACE_MESSAGE = 0x0,
55         XSCALE_TRACE_ADDRESS = 0x1,
56 };
57
58 typedef struct xscale_trace_entry_s
59 {
60         uint8_t data;
61         enum xscale_trace_entry_type type;
62 } xscale_trace_entry_t;
63
64 typedef struct xscale_trace_data_s
65 {
66         xscale_trace_entry_t *entries;
67         int depth;
68         uint32_t chkpt0;
69         uint32_t chkpt1;
70         uint32_t last_instruction;
71         struct xscale_trace_data_s *next;
72 } xscale_trace_data_t;
73
74 typedef struct xscale_trace_s
75 {
76         trace_status_t capture_status;  /* current state of capture run */
77         struct image_s *image;                                  /* source for target opcodes */
78         xscale_trace_data_t *data;              /* linked list of collected trace data */
79         int buffer_enabled;                             /* whether trace buffer is enabled */
80         int buffer_fill;                                /* maximum number of trace runs to read (-1 for wrap-around) */
81         int pc_ok;
82         uint32_t current_pc;
83         armv4_5_state_t core_state;             /* current core state (ARM, Thumb, Jazelle) */
84 } xscale_trace_t;
85
86 typedef struct xscale_common_s
87 {
88         int common_magic;
89
90         /* XScale registers (CP15, DBG) */
91         reg_cache_t *reg_cache;
92
93         /* pxa250, pxa255, pxa27x, ixp42x, ... */
94         char *variant;
95
96         xscale_jtag_t jtag_info;
97
98         /* current state of the debug handler */
99         int handler_installed;
100         int handler_running;
101         uint32_t handler_address;
102
103         /* target-endian buffers with exception vectors */
104         uint32_t low_vectors[8];
105         uint32_t high_vectors[8];
106
107         /* static low vectors */
108         uint8_t static_low_vectors_set; /* bit field with static vectors set by the user */
109         uint8_t static_high_vectors_set; /* bit field with static vectors set by the user */
110         uint32_t static_low_vectors[8];
111         uint32_t static_high_vectors[8];
112
113         /* DCache cleaning */
114         uint32_t cache_clean_address;
115
116         /* whether hold_rst and ext_dbg_break should be set */
117         int hold_rst;
118         int external_debug_break;
119
120         /* breakpoint / watchpoint handling */
121         int dbr_available;
122         int dbr0_used;
123         int dbr1_used;
124         int ibcr_available;
125         int ibcr0_used;
126         int     ibcr1_used;
127         uint32_t arm_bkpt;
128         uint16_t thumb_bkpt;
129
130         uint8_t vector_catch;
131
132         xscale_trace_t trace;
133
134         int arch_debug_reason;
135
136         /* armv4/5 common stuff */
137         armv4_5_common_t armv4_5_common;
138
139         /* MMU/Caches */
140         armv4_5_mmu_common_t armv4_5_mmu;
141         uint32_t cp15_control_reg;
142
143         /* possible future enhancements that go beyond XScale common stuff */
144         void *arch_info;
145
146         int fast_memory_access;
147 } xscale_common_t;
148
149 typedef struct xscale_reg_s
150 {
151         int dbg_handler_number;
152         target_t *target;
153 } xscale_reg_t;
154
155 enum
156 {
157         XSCALE_MAINID,          /* 0 */
158         XSCALE_CACHETYPE,
159         XSCALE_CTRL,
160         XSCALE_AUXCTRL,
161         XSCALE_TTB,
162         XSCALE_DAC,
163         XSCALE_FSR,
164         XSCALE_FAR,
165         XSCALE_PID,
166         XSCALE_CPACCESS,
167         XSCALE_IBCR0,           /* 10 */
168         XSCALE_IBCR1,
169         XSCALE_DBR0,
170         XSCALE_DBR1,
171         XSCALE_DBCON,
172         XSCALE_TBREG,
173         XSCALE_CHKPT0,
174         XSCALE_CHKPT1,
175         XSCALE_DCSR,
176         XSCALE_TX,
177         XSCALE_RX,                      /* 20 */
178         XSCALE_TXRXCTRL,
179 };
180
181 #define ERROR_XSCALE_NO_TRACE_DATA      (-1500)
182
183 #endif /* XSCALE_H */