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