ARM11: use shared DSCR bit names
[fw/openocd] / src / target / arm11.h
1 /***************************************************************************
2  *   Copyright (C) 2008 digenius technology GmbH.                          *
3  *   Michael Bruck                                                         *
4  *                                                                         *
5  *   Copyright (C) 2008 Georg Acher <acher@in.tum.de>                      *
6  *                                                                         *
7  *   This program is free software; you can redistribute it and/or modify  *
8  *   it under the terms of the GNU General Public License as published by  *
9  *   the Free Software Foundation; either version 2 of the License, or     *
10  *   (at your option) any later version.                                   *
11  *                                                                         *
12  *   This program is distributed in the hope that it will be useful,       *
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
15  *   GNU General Public License for more details.                          *
16  *                                                                         *
17  *   You should have received a copy of the GNU General Public License     *
18  *   along with this program; if not, write to the                         *
19  *   Free Software Foundation, Inc.,                                       *
20  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
21  ***************************************************************************/
22
23 #ifndef ARM11_H
24 #define ARM11_H
25
26 #include <target/armv4_5.h>
27 #include <target/arm_dpm.h>
28
29 #define ARM11_TAP_DEFAULT                       TAP_INVALID
30
31 #define CHECK_RETVAL(action)                    \
32         do {                                    \
33                 int __retval = (action);        \
34                 if (__retval != ERROR_OK) {     \
35                         LOG_DEBUG("error while calling \"%s\"", \
36                                 # action );     \
37                         return __retval;        \
38                 }                               \
39         } while (0)
40
41 /* bits from ARMv7 DIDR */
42 enum arm11_debug_version
43 {
44         ARM11_DEBUG_V6                  = 0x01,
45         ARM11_DEBUG_V61                 = 0x02,
46         ARM11_DEBUG_V7                  = 0x03,
47         ARM11_DEBUG_V7_CP14             = 0x04,
48 };
49
50 struct arm11_common
51 {
52         struct arm      arm;
53
54         /** Debug module state. */
55         struct arm_dpm dpm;
56
57         size_t  brp;                    /**< Number of Breakpoint Register Pairs from DIDR      */
58         size_t  wrp;                    /**< Number of Watchpoint Register Pairs from DIDR      */
59         size_t  free_brps;              /**< Number of breakpoints allocated */
60
61         uint32_t dscr;                  /**< Last retrieved DSCR value. */
62
63         uint32_t saved_rdtr;
64         uint32_t saved_wdtr;
65
66         bool is_rdtr_saved;
67         bool is_wdtr_saved;
68
69         bool    simulate_reset_on_next_halt;    /**< Perform cleanups of the ARM state on next halt */
70
71         struct arm_jtag jtag_info;
72 };
73
74 static inline struct arm11_common *target_to_arm11(struct target *target)
75 {
76         return container_of(target->arch_info, struct arm11_common,
77                         arm);
78 }
79
80 /**
81  * ARM11 DBGTAP instructions
82  *
83  * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0301f/I1006229.html
84  */
85 enum arm11_instructions
86 {
87         ARM11_EXTEST    = 0x00,
88         ARM11_SCAN_N    = 0x02,
89         ARM11_RESTART   = 0x04,
90         ARM11_HALT          = 0x08,
91         ARM11_INTEST    = 0x0C,
92         ARM11_ITRSEL    = 0x1D,
93         ARM11_IDCODE    = 0x1E,
94         ARM11_BYPASS    = 0x1F,
95 };
96
97 enum arm11_dscr
98 {
99
100         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_MASK                                   = 0x0F << 2,
101         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_HALT                                   = 0x00 << 2,
102         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BREAKPOINT                             = 0x01 << 2,
103         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_WATCHPOINT                             = 0x02 << 2,
104         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BKPT_INSTRUCTION               = 0x03 << 2,
105         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_EDBGRQ                                 = 0x04 << 2,
106         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_VECTOR_CATCH                   = 0x05 << 2,
107 };
108
109 enum arm11_sc7
110 {
111         ARM11_SC7_NULL                          = 0,
112         ARM11_SC7_VCR                           = 7,
113         ARM11_SC7_PC                            = 8,
114         ARM11_SC7_BVR0                          = 64,
115         ARM11_SC7_BCR0                          = 80,
116         ARM11_SC7_WVR0                          = 96,
117         ARM11_SC7_WCR0                          = 112,
118 };
119
120 #endif /* ARM11_H */