src/jtag/zy1000/jtag_minidriver.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007-2009 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 #include <cyg/hal/hal_io.h>             // low level i/o
  21
  22 //#define VERBOSE(a) a
  23 #define VERBOSE(a)
  24
  25 /* used to test manual mode */
  26 #define TEST_MANUAL() 0
  27
  28 #if 0
  29 int  diag_printf(const char *fmt, ...);
  30 #define ZY1000_POKE(a, b) HAL_WRITE_UINT32(a, b); diag_printf("poke 0x%08x,0x%08x\n", a, b)
  31 #define ZY1000_PEEK(a, b) HAL_READ_UINT32(a, b); diag_printf("peek 0x%08x = 0x%08x\n", a, b)
  32 #else
  33 #define ZY1000_PEEK(a, b) HAL_READ_UINT32(a, b)
  34 #define ZY1000_POKE(a, b) HAL_WRITE_UINT32(a, b);\
  35  {/* This will flush the bridge FIFO. Overflowed bridge FIFO fails. We must \
  36  flush every "often". No precise system has been found, but 4 seems solid. \
  37   */ \
  38  static int overflow_counter = 0; \
  39    if (++overflow_counter >= 1) \
  40    { \
  41            /* clear FIFO */ \
  42            cyg_uint32 empty; ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty); \
  43            overflow_counter = 0; \
  44    } \
  45  }
  46 #endif
  47
  48 // FIFO empty?
  49 static __inline__ void waitIdle(void)
  50 {
  51         cyg_uint32 empty;
  52         do
  53         {
  54                 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty);
  55         } while ((empty & 0x100) == 0);
  56 }
  57
  58 static __inline__ void waitQueue(void)
  59 {
  60 //      waitIdle();
  61 }
  62
  63 static void sampleShiftRegister(void)
  64 {
  65 #if 0
  66         cyg_uint32 dummy;
  67         waitIdle();
  68         ZY1000_PEEK(ZY1000_JTAG_BASE + 0xc, dummy);
  69 #endif
  70 }
  71
  72 /* -O3 will inline this for us */
  73 static void setCurrentState(enum tap_state state)
  74 {
  75         cyg_uint32 a;
  76         a = state;
  77         int repeat = 0;
  78         if (state == TAP_RESET)
  79         {
  80                 // The FPGA nor we know the current state of the CPU TAP
  81                 // controller. This will move it to TAP for sure.
  82                 //
  83                 // 5 should be enough here, 7 is what OpenOCD uses
  84                 repeat = 7;
  85         }
  86         waitQueue();
  87         sampleShiftRegister();
  88         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | a);
  89
  90 }
  91
  92 /*
  93  * Enter state and cause repeat transitions *out* of that state. So if the endState != state, then
  94  * the transition from state to endState counts as a transition out of state.
  95  */
  96 static __inline__ void shiftValueInner(const enum tap_state state, const enum tap_state endState, int repeat, cyg_uint32 value)
  97 {
  98         cyg_uint32 a,b;
  99         a = state;
 100         b = endState;
 101         waitQueue();
 102         sampleShiftRegister();
 103         ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value);
 104 #if 1
 105 #if TEST_MANUAL()
 106         if ((state == TAP_DRSHIFT) && (endState != TAP_DRSHIFT))
 107         {
 108                 int i;
 109                 setCurrentState(state);
 110                 for (i = 0; i < repeat; i++)
 111                 {
 112                         int tms;
 113                         tms = 0;
 114                         if ((i == repeat-1) && (state != endState))
 115                         {
 116                                 tms = 1;
 117                         }
 118                         /* shift out value */
 119                         waitIdle();
 120                         ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, (((value >> i)&1) << 1) | tms);
 121                 }
 122                 waitIdle();
 123                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, 0);
 124                 waitIdle();
 125                 //ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_DRSHIFT); // set this state and things break => expected
 126                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_DRPAUSE); // set this and things will work => expected. Not setting this is not sufficient to make things break.
 127                 setCurrentState(endState);
 128         } else
 129         {
 130                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
 131         }
 132 #else
 133         /* fast version */
 134         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
 135 #endif
 136 #else
 137         /* maximum debug version */
 138         if ((repeat > 0) && ((state == TAP_DRSHIFT)||(state == TAP_SI)))
 139         {
 140                 int i;
 141                 /* sample shift register for every bit. */
 142                 for (i = 0; i < repeat-1; i++)
 143                 {
 144                         sampleShiftRegister();
 145                         ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> i);
 146                         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | a);
 147                 }
 148                 sampleShiftRegister();
 149                 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> (repeat-1));
 150                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | b);
 151         } else
 152         {
 153                 sampleShiftRegister();
 154                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
 155         }
 156         sampleShiftRegister();
 157 #endif
 158 }
 159
 160
 161
 162 static __inline__ void interface_jtag_add_dr_out_core(struct jtag_tap *target_tap,
 163                 int num_fields,
 164                 const int *num_bits,
 165                 const uint32_t *value,
 166                 enum tap_state end_state)
 167 {
 168         enum tap_state pause_state = TAP_DRSHIFT;
 169
 170         struct jtag_tap *tap, *nextTap;
 171         for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
 172         {
 173                 nextTap = jtag_tap_next_enabled(tap);
 174                 if (nextTap == NULL)
 175                 {
 176                         pause_state = end_state;
 177                 }
 178                 if (tap == target_tap)
 179                 {
 180                         int j;
 181                         for (j = 0; j < (num_fields-1); j++)
 182                         {
 183                                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[j], value[j]);
 184                         }
 185                         shiftValueInner(TAP_DRSHIFT, pause_state, num_bits[j], value[j]);
 186                 } else
 187                 {
 188                         /* program the scan field to 1 bit length, and ignore it's value */
 189                         shiftValueInner(TAP_DRSHIFT, pause_state, 1, 0);
 190                 }
 191         }
 192 }
 193
 194 static __inline__ void interface_jtag_add_dr_out(struct jtag_tap *target_tap,
 195                 int num_fields,
 196                 const int *num_bits,
 197                 const uint32_t *value,
 198                 enum tap_state end_state)
 199 {
 200
 201         int singletap = (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL)) == NULL);
 202         if ((singletap) && (num_fields == 3))
 203         {
 204                 /* used by embeddedice_write_reg_inner() */
 205                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
 206                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[1], value[1]);
 207                 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[2], value[2]);
 208         } else if ((singletap) && (num_fields == 2))
 209         {
 210                 /* used by arm7 code */
 211                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
 212                 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[1], value[1]);
 213         } else
 214         {
 215                 interface_jtag_add_dr_out_core(target_tap, num_fields, num_bits, value, end_state);
 216         }
 217 }
 218
 219 #define interface_jtag_add_callback(callback, in) callback(in)
 220
 221 #define interface_jtag_add_callback4(callback, in, data1, data2, data3) jtag_set_error(callback(in, data1, data2, data3))