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 "armv4_5.h"
  27 #include "arm_dpm.h"
  28
  29 #define ARM11_REGCACHE_COUNT            3
  30
  31 #define ARM11_TAP_DEFAULT                       TAP_INVALID
  32
  33 #define CHECK_RETVAL(action)                    \
  34         do {                                    \
  35                 int __retval = (action);        \
  36                 if (__retval != ERROR_OK) {     \
  37                         LOG_DEBUG("error while calling \"%s\"", \
  38                                 # action );     \
  39                         return __retval;        \
  40                 }                               \
  41         } while (0)
  42
  43 enum arm11_debug_version
  44 {
  45         ARM11_DEBUG_V6                  = 0x01,
  46         ARM11_DEBUG_V61                 = 0x02,
  47         ARM11_DEBUG_V7                  = 0x03,
  48         ARM11_DEBUG_V7_CP14             = 0x04,
  49 };
  50
  51 struct arm11_common
  52 {
  53         struct arm      arm;
  54
  55         /** Debug module state. */
  56         struct arm_dpm dpm;
  57
  58         size_t  brp;                    /**< Number of Breakpoint Register Pairs from DIDR      */
  59         size_t  wrp;                    /**< Number of Watchpoint Register Pairs from DIDR      */
  60         size_t  free_brps;              /**< Number of breakpoints allocated */
  61
  62         uint32_t                last_dscr;              /**< Last retrieved DSCR value;
  63                                                              Use only for debug message generation              */
  64
  65         bool    simulate_reset_on_next_halt;    /**< Perform cleanups of the ARM state on next halt */
  66
  67         /** \name Shadow registers to save debug state */
  68         /*@{*/
  69
  70         struct reg *    reg_list;                                                       /**< target register list */
  71         uint32_t                reg_values[ARM11_REGCACHE_COUNT];       /**< data for registers */
  72
  73         /*@}*/
  74
  75
  76         // GA
  77         struct reg_cache *core_cache;
  78
  79         struct arm_jtag jtag_info;
  80 };
  81
  82 static inline struct arm11_common *target_to_arm11(struct target *target)
  83 {
  84         return container_of(target->arch_info, struct arm11_common,
  85                         arm);
  86 }
  87
  88 /**
  89  * ARM11 DBGTAP instructions
  90  *
  91  * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0301f/I1006229.html
  92  */
  93 enum arm11_instructions
  94 {
  95         ARM11_EXTEST    = 0x00,
  96         ARM11_SCAN_N    = 0x02,
  97         ARM11_RESTART   = 0x04,
  98         ARM11_HALT          = 0x08,
  99         ARM11_INTEST    = 0x0C,
 100         ARM11_ITRSEL    = 0x1D,
 101         ARM11_IDCODE    = 0x1E,
 102         ARM11_BYPASS    = 0x1F,
 103 };
 104
 105 enum arm11_dscr
 106 {
 107         ARM11_DSCR_CORE_HALTED                                                                  = 1 << 0,
 108         ARM11_DSCR_CORE_RESTARTED                                                               = 1 << 1,
 109
 110         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_MASK                                   = 0x0F << 2,
 111         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_HALT                                   = 0x00 << 2,
 112         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BREAKPOINT                             = 0x01 << 2,
 113         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_WATCHPOINT                             = 0x02 << 2,
 114         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BKPT_INSTRUCTION               = 0x03 << 2,
 115         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_EDBGRQ                                 = 0x04 << 2,
 116         ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_VECTOR_CATCH                   = 0x05 << 2,
 117
 118         ARM11_DSCR_STICKY_PRECISE_DATA_ABORT                                    = 1 << 6,
 119         ARM11_DSCR_STICKY_IMPRECISE_DATA_ABORT                                  = 1 << 7,
 120         ARM11_DSCR_INTERRUPTS_DISABLE                                                   = 1 << 11,
 121         ARM11_DSCR_EXECUTE_ARM_INSTRUCTION_ENABLE                               = 1 << 13,
 122         ARM11_DSCR_MODE_SELECT                                                                  = 1 << 14,
 123         ARM11_DSCR_WDTR_FULL                                                                    = 1 << 29,
 124         ARM11_DSCR_RDTR_FULL                                                                    = 1 << 30,
 125 };
 126
 127 enum arm11_cpsr
 128 {
 129         ARM11_CPSR_T                            = 1 << 5,
 130         ARM11_CPSR_J                            = 1 << 24,
 131 };
 132
 133 enum arm11_sc7
 134 {
 135         ARM11_SC7_NULL                          = 0,
 136         ARM11_SC7_VCR                           = 7,
 137         ARM11_SC7_PC                            = 8,
 138         ARM11_SC7_BVR0                          = 64,
 139         ARM11_SC7_BCR0                          = 80,
 140         ARM11_SC7_WVR0                          = 96,
 141         ARM11_SC7_WCR0                          = 112,
 142 };
 143
 144 struct arm11_reg_state
 145 {
 146         uint32_t                                def_index;
 147         struct target *                 target;
 148 };
 149
 150 #endif /* ARM11_H */