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