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  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  21  ***************************************************************************/
  22
  23 #ifndef ARM11_H
  24 #define ARM11_H
  25
  26 #include "arm.h"
  27 #include "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         ARM11_DEBUG_V6                  = 0x01,
  44         ARM11_DEBUG_V61                 = 0x02,
  45         ARM11_DEBUG_V7                  = 0x03,
  46         ARM11_DEBUG_V7_CP14             = 0x04,
  47 };
  48
  49 struct arm11_common {
  50         struct arm arm;
  51
  52         /** Debug module state. */
  53         struct arm_dpm dpm;
  54         struct arm11_sc7_action *bpwp_actions;
  55         unsigned bpwp_n;
  56
  57         size_t brp;                     /**< Number of Breakpoint Register Pairs from DIDR      */
  58         size_t free_brps;               /**< Number of breakpoints allocated */
  59
  60         uint32_t dscr;                  /**< Last retrieved DSCR value. */
  61
  62         uint32_t saved_rdtr;
  63         uint32_t saved_wdtr;
  64
  65         bool is_rdtr_saved;
  66         bool is_wdtr_saved;
  67
  68         bool simulate_reset_on_next_halt;       /**< Perform cleanups of the ARM state on next halt **/
  69
  70         /* Per-core configurable options.
  71          * NOTE that several of these boolean options should not exist
  72          * once the relevant code is known to work correctly.
  73          */
  74         bool memwrite_burst;
  75         bool memwrite_error_fatal;
  76         bool step_irq_enable;
  77         bool hardware_step;
  78
  79         /** Configured Vector Catch Register settings. */
  80         uint32_t vcr;
  81
  82         struct arm_jtag jtag_info;
  83 };
  84
  85 static inline struct arm11_common *target_to_arm11(struct target *target)
  86 {
  87         return container_of(target->arch_info, struct arm11_common, arm);
  88 }
  89
  90 /**
  91  * ARM11 DBGTAP instructions
  92  *
  93  * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0301f/I1006229.html
  94  */
  95 enum arm11_instructions {
  96         ARM11_EXTEST    = 0x00,
  97         ARM11_SCAN_N    = 0x02,
  98         ARM11_RESTART   = 0x04,
  99         ARM11_HALT          = 0x08,
 100         ARM11_INTEST    = 0x0C,
 101         ARM11_ITRSEL    = 0x1D,
 102         ARM11_IDCODE    = 0x1E,
 103         ARM11_BYPASS    = 0x1F,
 104 };
 105
 106 enum arm11_sc7 {
 107         ARM11_SC7_NULL                          = 0,
 108         ARM11_SC7_VCR                           = 7,
 109         ARM11_SC7_PC                            = 8,
 110         ARM11_SC7_BVR0                          = 64,
 111         ARM11_SC7_BCR0                          = 80,
 112         ARM11_SC7_WVR0                          = 96,
 113         ARM11_SC7_WCR0                          = 112,
 114 };
 115
 116 #endif  /* ARM11_H */