git.gag.com Git - fw/openocd/blob - src/jtag/zy1000/jtag_minidriver.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007-2010 by Øyvind Harboe                              *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  18  ***************************************************************************/
  19
  20 /* used to test manual mode */
  21 #define TEST_MANUAL() 0
  22 #define VERBOSE(a)
  23
  24 #if BUILD_ZY1000_MASTER
  25
  26 #if BUILD_ECOSBOARD
  27 #include <cyg/hal/hal_io.h>             /* low level i/o */
  28 #include <cyg/hal/hal_intr.h>                   /* low level i/o */
  29 #define ZY1000_PEEK(a, b) HAL_READ_UINT32(a, b)
  30 #define ZY1000_POKE(a, b) HAL_WRITE_UINT32(a, b)
  31 #else
  32 #define ZY1000_PEEK(a, b) do {b = *((volatile uint32_t *)(a)); } while (0)
  33 #define ZY1000_POKE(a, b) do {*((volatile uint32_t *)(a)) = b; } while (0)
  34 extern volatile void *zy1000_jtag_master;
  35 #define ZY1000_JTAG_BASE ((unsigned long)zy1000_jtag_master)
  36 #endif
  37
  38 #else
  39
  40 /* redirect this to TCP/IP */
  41 #define ZY1000_JTAG_BASE 0
  42 extern void zy1000_tcpout(uint32_t address, uint32_t data);
  43 extern uint32_t zy1000_tcpin(uint32_t address);
  44 #define ZY1000_PEEK(a, b) b = zy1000_tcpin(a)
  45 #define ZY1000_POKE(a, b) zy1000_tcpout(a, b)
  46
  47 #endif
  48
  49 #if BUILD_ZY1000_MASTER
  50 /* FIFO empty? */
  51 static inline void waitIdle(void)
  52 {
  53         uint32_t empty;
  54         do {
  55                 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty);
  56         } while ((empty & 0x100) == 0);
  57 }
  58
  59 static inline void zy1000_flush_readqueue(void)
  60 {
  61         /* Not used w/hardware fifo */
  62 }
  63 static inline void zy1000_flush_callbackqueue(void)
  64 {
  65         /* Not used w/hardware fifo */
  66 }
  67 #else
  68 extern void waitIdle(void);
  69 void zy1000_flush_readqueue(void);
  70 void zy1000_flush_callbackqueue(void);
  71 void zy1000_jtag_add_callback4(jtag_callback_t callback,
  72                 jtag_callback_data_t data0,
  73                 jtag_callback_data_t data1,
  74                 jtag_callback_data_t data2,
  75                 jtag_callback_data_t data3);
  76 void zy1000_jtag_add_callback(jtag_callback1_t callback, jtag_callback_data_t data0);
  77 #endif
  78
  79 static inline void waitQueue(void)
  80 {
  81 /*      waitIdle(); */
  82 }
  83
  84 static inline void sampleShiftRegister(void)
  85 {
  86 #if 0
  87         uint32_t dummy;
  88         waitIdle();
  89         ZY1000_PEEK(ZY1000_JTAG_BASE + 0xc, dummy);
  90 #endif
  91 }
  92
  93 static inline void setCurrentState(enum tap_state state)
  94 {
  95         uint32_t a;
  96         a = state;
  97         int repeat = 0;
  98         if (state == TAP_RESET) {
  99                 /* The FPGA nor we know the current state of the CPU TAP */
 100                 /* controller. This will move it to TAP for sure. */
 101                 /*  */
 102                 /* 5 should be enough here, 7 is what OpenOCD uses */
 103                 repeat = 7;
 104         }
 105         waitQueue();
 106         sampleShiftRegister();
 107         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | a);
 108
 109 }
 110
 111 /*
 112  * Enter state and cause repeat transitions *out* of that state. So if the endState != state, then
 113  * the transition from state to endState counts as a transition out of state.
 114  */
 115 static inline void shiftValueInner(const enum tap_state state,
 116         const enum tap_state endState,
 117         int repeat,
 118         uint32_t value)
 119 {
 120         uint32_t a, b;
 121         a = state;
 122         b = endState;
 123         waitQueue();
 124         sampleShiftRegister();
 125         ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value);
 126 #if 1
 127 #if TEST_MANUAL()
 128         if ((state == TAP_DRSHIFT) && (endState != TAP_DRSHIFT)) {
 129                 int i;
 130                 setCurrentState(state);
 131                 for (i = 0; i < repeat; i++) {
 132                         int tms;
 133                         tms = 0;
 134                         if ((i == repeat-1) && (state != endState))
 135                                 tms = 1;
 136                                         /* shift out value */
 137                         waitIdle();
 138                         ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, (((value >> i)&1) << 1) | tms);
 139                 }
 140                 waitIdle();
 141                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, 0);
 142                 waitIdle();
 143                 /* ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_DRSHIFT); // set this state and things
 144                  * break => expected */
 145                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_DRPAUSE);      /* set this and things will
 146                                                                          * work => expected. Not
 147                                                                          * setting this is not
 148                                                                          * sufficient to make things
 149                                                                          * break. */
 150                 setCurrentState(endState);
 151         } else
 152                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
 153
 154 #else
 155         /* fast version */
 156         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
 157 #endif
 158 #else
 159         /* maximum debug version */
 160         if ((repeat > 0) && ((state == TAP_DRSHIFT) || (state == TAP_SI))) {
 161                 int i;
 162                 /* sample shift register for every bit. */
 163                 for (i = 0; i < repeat-1; i++) {
 164                         sampleShiftRegister();
 165                         ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> i);
 166                         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | a);
 167                 }
 168                 sampleShiftRegister();
 169                 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> (repeat-1));
 170                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | b);
 171         } else {
 172                 sampleShiftRegister();
 173                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
 174         }
 175         sampleShiftRegister();
 176 #endif
 177 }
 178
 179 static inline void interface_jtag_add_dr_out_core(struct jtag_tap *target_tap,
 180         int num_fields,
 181         const int *num_bits,
 182         const uint32_t *value,
 183         enum tap_state end_state)
 184 {
 185         enum tap_state pause_state = TAP_DRSHIFT;
 186
 187         struct jtag_tap *tap, *nextTap;
 188         for (tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = nextTap) {
 189                 nextTap = jtag_tap_next_enabled(tap);
 190                 if (nextTap == NULL)
 191                         pause_state = end_state;
 192                 if (tap == target_tap) {
 193                         int j;
 194                         for (j = 0; j < (num_fields-1); j++)
 195                                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[j], value[j]);
 196                         shiftValueInner(TAP_DRSHIFT, pause_state, num_bits[j], value[j]);
 197                 } else {
 198                         /* program the scan field to 1 bit length, and ignore it's value */
 199                         shiftValueInner(TAP_DRSHIFT, pause_state, 1, 0);
 200                 }
 201         }
 202 }
 203
 204 static inline void interface_jtag_add_dr_out(struct jtag_tap *target_tap,
 205         int num_fields,
 206         const int *num_bits,
 207         const uint32_t *value,
 208         enum tap_state end_state)
 209 {
 210
 211         int singletap = (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL)) == NULL);
 212         if ((singletap) && (num_fields == 3)) {
 213                 /* used by embeddedice_write_reg_inner() */
 214                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
 215                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[1], value[1]);
 216                 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[2], value[2]);
 217         } else if ((singletap) && (num_fields == 2)) {
 218                 /* used by arm7 code */
 219                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
 220                 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[1], value[1]);
 221         } else
 222                 interface_jtag_add_dr_out_core(target_tap, num_fields, num_bits, value, end_state);
 223 }
 224
 225 #if BUILD_ZY1000_MASTER
 226 #define interface_jtag_add_callback(callback, in) callback(in)
 227 #define interface_jtag_add_callback4(callback, in, data1, data2, \
 228                 data3) jtag_set_error(callback(in, data1, data2, data3))
 229 #else
 230 #define interface_jtag_add_callback(callback, in) zy1000_jtag_add_callback(callback, in)
 231 #define interface_jtag_add_callback4(callback, in, data1, data2, data3) zy1000_jtag_add_callback4( \
 232         callback, \
 233         in, \
 234         data1, \
 235         data2, \
 236         data3)
 237 #endif