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