git.rot13.org Git - goodfet/blob - firmware/include/jtagarm7.h

   1 /*! \file jtagarm7tdmi.h
   2   \brief JTAG handler functions for the ARM7TDMI family of processors
   3 */
   4
   5 #ifndef JTAGARM7_H
   6 #define JTAGARM7_H
   7
   8 #include "app.h"
   9
  10 #define JTAGARM7 0x13
  11
  12 #define JTAGSTATE_ARM 0         // bit 4 on dbg status reg is low
  13 #define JTAGSTATE_THUMB 1
  14
  15 // JTAGARM7 Commands
  16
  17 //! Start JTAG
  18 void jtagarm7tdmi_start(void);
  19
  20 //!  Set a 32-bit ARM register
  21 void jtagarm7tdmi_set_register(unsigned long reg, unsigned long val);
  22 //!  Get a 32-bit ARM register
  23 unsigned long jtagarm7tdmi_get_register(unsigned long reg);
  24
  25 // ARM7TDMI-specific pins
  26 // DBGRQ - GoodFET Pin 8
  27 #define DBGRQ   TST
  28
  29 /*      ARM7TDMI data
  30 The instruction register is 4 bits in length.
  31 There is no parity bit.
  32 The fixed value 0001 is loaded into the instruction register during the CAPTURE-IR
  33 controller state.
  34 The least significant bit of the instruction register is scanned in and scanned out first.
  35 */
  36
  37 //4-bit ARM7TDMI JTAG commands, bit-swapped
  38 #define ARM7TDMI_IR_EXTEST              0x0
  39 #define ARM7TDMI_IR_SCAN_N              0x2
  40 #define ARM7TDMI_IR_SAMPLE              0x3
  41 #define ARM7TDMI_IR_RESTART             0x4
  42 #define ARM7TDMI_IR_CLAMP               0x5
  43 #define ARM7TDMI_IR_HIGHZ               0x7
  44 #define ARM7TDMI_IR_CLAMPZ              0x9
  45 #define ARM7TDMI_IR_INTEST              0xC
  46 #define ARM7TDMI_IR_IDCODE              0xE
  47 #define ARM7TDMI_IR_BYPASS              0xF
  48
  49 // read 3 bit - Debug Control
  50 #define EICE_DBGCTRL                    0
  51 #define EICE_DBGCTRL_BITLEN             3
  52 // read 5 bit - Debug Status
  53 #define EICE_DBGSTATUS                  1
  54 #define EICE_DBGSTATUS_BITLEN           5
  55 // read 6 bit - Debug Comms Control Register
  56 #define EICE_DBGCCR                     4
  57 #define EICE_DBGCCR_BITLEN              6
  58 // r/w 32 bit - Debug Comms Data Register
  59 #define EICE_DBGCDR                     5
  60 // r/w 32 bit - Watchpoint 0 Address
  61 #define EICE_WP0ADDR                    8
  62 // r/w 32 bit - Watchpoint 0 Addres Mask
  63 #define EICE_WP0ADDRMASK                9
  64 // r/w 32 bit - Watchpoint 0 Data
  65 #define EICE_WP0DATA                    10
  66 // r/w 32 bit - Watchpoint 0 Data Masl
  67 #define EICE_WP0DATAMASK                11
  68 // r/w 9 bit - Watchpoint 0 Control Value
  69 #define EICE_WP0CTRL                    12
  70 // r/w 8 bit - Watchpoint 0 Control Mask
  71 #define EICE_WP0CTRLMASK                13
  72 // r/w 32 bit - Watchpoint 0 Address
  73 #define EICE_WP1ADDR                    16
  74 // r/w 32 bit - Watchpoint 0 Addres Mask
  75 #define EICE_WP1ADDRMASK                17
  76 // r/w 32 bit - Watchpoint 0 Data
  77 #define EICE_WP1DATA                    18
  78 // r/w 32 bit - Watchpoint 0 Data Masl
  79 #define EICE_WP1DATAMASK                19
  80 // r/w 9 bit - Watchpoint 0 Control Value
  81 #define EICE_WP1CTRL                    20
  82 // r/w 8 bit - Watchpoint 0 Control Mask
  83 #define EICE_WP1CTRLMASK                21
  84
  85
  86 //JTAGARM7TDMI commands
  87 #define JTAGARM7_GET_REGISTER               0x87
  88 #define JTAGARM7_SET_REGISTER               0x88
  89 #define JTAGARM7_DEBUG_INSTR                0x89
  90 // Really ARM specific stuff
  91 #define JTAGARM7_SET_IR                     0x90
  92 #define JTAGARM7_WAIT_DBG                   0x91
  93 #define JTAGARM7_SHIFT_DR                   0x92
  94 #define JTAGARM7_CHAIN0                     0x93
  95 #define JTAGARM7_SCANCHAIN1                 0x94
  96 #define JTAGARM7_EICE_READ                  0x95
  97 #define JTAGARM7_EICE_WRITE                 0x96
  98
  99
 100 // for deeper understanding, read the instruction cycle timing section of:
 101 //      http://www.atmel.com/dyn/resources/prod_documents/DDI0029G_7TDMI_R3_trm.pdf
 102 #define EXECNOPARM                  0xe1a00000L
 103 #define ARM_INSTR_NOP               0xe1a00000L
 104 #define ARM_INSTR_BX_R0             0xe12fff10L
 105 #define ARM_INSTR_STR_Rx_r14        0xe58f0000L // from atmel docs
 106 #define ARM_READ_REG                ARM_INSTR_STR_Rx_r14
 107 #define ARM_INSTR_LDR_Rx_r14        0xe5900000L // NOT from atmel docs (e59e0000L is from atmel docs)
 108 #define ARM_WRITE_REG               ARM_INSTR_LDR_Rx_r14
 109 #define ARM_INSTR_LDR_R1_r0_4       0xe4901004L
 110 #define ARM_READ_MEM                ARM_INSTR_LDR_R1_r0_4
 111 #define ARM_INSTR_STR_R1_r0_4       0xe4801004L
 112 #define ARM_WRITE_MEM               ARM_INSTR_STR_R1_r0_4
 113 #define ARM_INSTR_MRS_R0_CPSR       0xe10f0000L
 114 #define ARM_INSTR_MSR_cpsr_cxsf_R0  0xe12ff000L
 115 #define ARM_INSTR_STMIA_R14_r0_rx   0xE88E0000L      // add up to 65k to indicate which registers...
 116 #define ARM_STORE_MULTIPLE          ARM_INSTR_STMIA_R14_r0_rx
 117 #define ARM_INSTR_SKANKREGS         0xE88F7fffL
 118 #define ARM_INSTR_CLOBBEREGS        0xE89F7fffL
 119
 120 #define ARM_INSTR_B_IMM             0xea000000L
 121 #define ARM_INSTR_BX_PC             0xe12fff10L      // need to set r0 to the desired address
 122 #define THUMB_INSTR_LDR_R0_r0       0x68006800L
 123 #define THUMB_WRITE_REG             THUMB_INSTR_LDR_R0_r0
 124 #define THUMB_INSTR_STR_R0_r0       0x60006000L
 125 #define THUMB_READ_REG              THUMB_INSTR_STR_R0_r0
 126 #define THUMB_INSTR_MOV_R0_PC       0x46b846b8L
 127 #define THUMB_INSTR_MOV_PC_R0       0x46474647L
 128 #define THUMB_INSTR_MOV_HiLo        0x46404640L
 129 #define THUMB_INSTR_MOV_LoHi        0x46804680L
 130 #define THUMB_INSTR_BX_PC           0x47784778L
 131 #define THUMB_INSTR_NOP             0x1c001c00L
 132 #define THUMB_SWAP_HiLo             0
 133 #define THUMB_SWAP_LoHi             1
 134 #define ARM_REG_PC                  15
 135
 136 #define JTAG_ARM7TDMI_DBG_DBGACK    1
 137 #define JTAG_ARM7TDMI_DBG_DBGRQ     2
 138 #define JTAG_ARM7TDMI_DBG_IFEN      4
 139 #define JTAG_ARM7TDMI_DBG_cgenL     8
 140 #define JTAG_ARM7TDMI_DBG_TBIT      16
 141
 142 extern app_t const jtagarm7_app;
 143
 144 #endif // JTAGARM7_H
 145