src/jtag/interface.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2009 Zachary T Welch                                    *
   9  *   zw@superlucidity.net                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26 #ifndef OPENOCD_JTAG_INTERFACE_H
  27 #define OPENOCD_JTAG_INTERFACE_H
  28
  29 #include "jtag.h"
  30
  31 /* @file
  32  * The "Cable Helper API" is what the cable drivers can use to help
  33  * implement their "Cable API".  So a Cable Helper API is a set of
  34  * helper functions used by cable drivers, and this is different from a
  35  * Cable API.  A "Cable API" is what higher level code used to talk to a
  36  * cable.
  37  */
  38
  39
  40 /** implementation of wrapper function tap_set_state() */
  41 void tap_set_state_impl(tap_state_t new_state);
  42
  43 /**
  44  * This function sets the state of a "state follower" which tracks the
  45  * state of the TAPs connected to the cable.  The state follower is
  46  * hopefully always in the same state as the actual TAPs in the jtag
  47  * chain, and will be so if there are no bugs in the tracking logic
  48  * within that cable driver.
  49  *
  50  * All the cable drivers call this function to indicate the state they
  51  * think the TAPs attached to their cables are in.  Because this
  52  * function can also log transitions, it will be helpful to call this
  53  * function with every transition that the TAPs being manipulated are
  54  * expected to traverse, not just end points of a multi-step state path.
  55  *
  56  * @param new_state The state we think the TAPs are currently in (or
  57  *      are about to enter).
  58  */
  59 #if defined(_DEBUG_JTAG_IO_)
  60 #define tap_set_state(new_state) \
  61         do { \
  62                 LOG_DEBUG("tap_set_state(%s)", tap_state_name(new_state)); \
  63                 tap_set_state_impl(new_state); \
  64         } while (0)
  65 #else
  66 static inline void tap_set_state(tap_state_t new_state)
  67 {
  68         tap_set_state_impl(new_state);
  69 }
  70 #endif
  71
  72 /**
  73  * This function gets the state of the "state follower" which tracks the
  74  * state of the TAPs connected to the cable. @see tap_set_state @return
  75  * tap_state_t The state the TAPs are in now.
  76  */
  77 tap_state_t tap_get_state(void);
  78
  79 /**
  80  * This function sets the state of an "end state follower" which tracks
  81  * the state that any cable driver thinks will be the end (resultant)
  82  * state of the current TAP SIR or SDR operation.
  83  *
  84  * At completion of that TAP operation this value is copied into the
  85  * state follower via tap_set_state().
  86  *
  87  * @param new_end_state The state the TAPs should enter at completion of
  88  *      a pending TAP operation.
  89  */
  90 void tap_set_end_state(tap_state_t new_end_state);
  91
  92 /**
  93  * For more information, @see tap_set_end_state
  94  * @return tap_state_t - The state the TAPs should be in at completion of the current TAP operation.
  95  */
  96 tap_state_t tap_get_end_state(void);
  97
  98 /**
  99  * This function provides a "bit sequence" indicating what has to be
 100  * done with TMS during a sequence of seven TAP clock cycles in order to
 101  * get from state \a "from" to state \a "to".
 102  *
 103  * The length of the sequence must be determined with a parallel call to
 104  * tap_get_tms_path_len().
 105  *
 106  * @param from The starting state.
 107  * @param to The desired final state.
 108  * @return int The required TMS bit sequence, with the first bit in the
 109  *      sequence at bit 0.
 110  */
 111 int tap_get_tms_path(tap_state_t from, tap_state_t to);
 112
 113
 114 /**
 115  * Function int tap_get_tms_path_len
 116  * returns the total number of bits that represents a TMS path
 117  * transition as given by the function tap_get_tms_path().
 118  *
 119  * For at least one interface (JLink) it's not OK to simply "pad" TMS
 120  * sequences to fit a whole byte.  (I suspect this is a general TAP
 121  * problem within OOCD.) Padding TMS causes all manner of instability
 122  * that's not easily discovered.  Using this routine we can apply
 123  * EXACTLY the state transitions required to make something work - no
 124  * more - no less.
 125  *
 126  * @param from is the starting state
 127  * @param to is the resultant or final state
 128  * @return int - the total number of bits in a transition.
 129  */
 130 int tap_get_tms_path_len(tap_state_t from, tap_state_t to);
 131
 132
 133 /**
 134  * Function tap_move_ndx
 135  * when given a stable state, returns an index from 0-5.  The index corresponds to a
 136  * sequence of stable states which are given in this order: <p>
 137  * { TAP_RESET, TAP_IDLE, TAP_DRSHIFT, TAP_DRPAUSE, TAP_IRSHIFT, TAP_IRPAUSE }
 138  * <p>
 139  * This sequence corresponds to look up tables which are used in some of the
 140  * cable drivers.
 141  * @param astate is the stable state to find in the sequence.  If a non stable
 142  *  state is passed, this may cause the program to output an error message
 143  *  and terminate.
 144  * @return int - the array (or sequence) index as described above
 145  */
 146 int tap_move_ndx(tap_state_t astate);
 147
 148 /**
 149  * Function tap_is_state_stable
 150  * returns true if the \a astate is stable.
 151  */
 152 bool tap_is_state_stable(tap_state_t astate);
 153
 154 /**
 155  * Function tap_state_transition
 156  * takes a current TAP state and returns the next state according to the tms value.
 157  * @param current_state is the state of a TAP currently.
 158  * @param tms is either zero or non-zero, just like a real TMS line in a jtag interface.
 159  * @return tap_state_t - the next state a TAP would enter.
 160  */
 161 tap_state_t tap_state_transition(tap_state_t current_state, bool tms);
 162
 163 /// Allow switching between old and new TMS tables. @see tap_get_tms_path
 164 void tap_use_new_tms_table(bool use_new);
 165 /// @returns True if new TMS table is active; false otherwise.
 166 bool tap_uses_new_tms_table(void);
 167
 168 #ifdef _DEBUG_JTAG_IO_
 169 /**
 170  * @brief Prints verbose TAP state transitions for the given TMS/TDI buffers.
 171  * @param tms_buf must points to a buffer containing the TMS bitstream.
 172  * @param tdi_buf must points to a buffer containing the TDI bitstream.
 173  * @param tap_len must specify the length of the TMS/TDI bitstreams.
 174  * @param start_tap_state must specify the current TAP state.
 175  * @returns the final TAP state; pass as @a start_tap_state in following call.
 176  */
 177 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
 178                 unsigned tap_len, tap_state_t start_tap_state);
 179 #else
 180 static inline tap_state_t jtag_debug_state_machine(const void *tms_buf,
 181                 const void *tdi_buf, unsigned tap_len, tap_state_t start_tap_state)
 182 {
 183         return start_tap_state;
 184 }
 185 #endif // _DEBUG_JTAG_IO_
 186
 187 typedef struct jtag_interface_s
 188 {
 189         /// The name of the JTAG interface driver.
 190         char* name;
 191
 192         /**
 193          * Execute queued commands.
 194          * @returns ERROR_OK on success, or an error code on failure.
 195          */
 196         int (*execute_queue)(void);
 197
 198         /**
 199          * Set the interface speed.
 200          * @param speed The new interface speed setting.
 201          * @returns ERROR_OK on success, or an error code on failure.
 202          */
 203         int (*speed)(int speed);
 204
 205         /**
 206          * The interface driver may register additional commands to expose
 207          * additional features not covered by the standard command set.
 208          * @param cmd_ctx The context in which commands should be registered.
 209          * @returns ERROR_OK on success, or an error code on failure.
 210          */
 211         int (*register_commands)(struct command_context_s* cmd_ctx);
 212
 213         /**
 214          * Interface driver must initalize any resources and connect to a
 215          * JTAG device.
 216          * @returns ERROR_OK on success, or an error code on failure.
 217          */
 218         int (*init)(void);
 219
 220         /**
 221          * Interface driver must tear down all resources and disconnect from
 222          * the JTAG device.
 223          * @returns ERROR_OK on success, or an error code on failure.
 224          */
 225         int (*quit)(void);
 226
 227         /**
 228          * Returns JTAG maxium speed for KHz. 0 = RTCK. The function returns
 229          *  a failure if it can't support the KHz/RTCK.
 230          *
 231          *  WARNING!!!! if RTCK is *slow* then think carefully about
 232          *  whether you actually want to support this in the driver.
 233          *  Many target scripts are written to handle the absence of RTCK
 234          *  and use a fallback kHz TCK.
 235          * @returns ERROR_OK on success, or an error code on failure.
 236          */
 237         int (*khz)(int khz, int* jtag_speed);
 238
 239         /**
 240          * Calculate the clock frequency (in KHz) for the given @a speed.
 241          * @param speed The desired interface speed setting.
 242          * @param khz On return, contains the speed in KHz (0 for RTCK).
 243          * @returns ERROR_OK on success, or an error code if the
 244          * interface cannot support the specified speed (KHz or RTCK).
 245          */
 246         int (*speed_div)(int speed, int* khz);
 247
 248         /**
 249          * Read and clear the power dropout flag. Note that a power dropout
 250          * can be transitionary, easily much less than a ms.
 251          *
 252          * To find out if the power is *currently* on, one must invoke this
 253          * method twice.  Once to clear the power dropout flag and a second
 254          * time to read the current state.  The default implementation
 255          * never reports power dropouts.
 256          *
 257          * @returns ERROR_OK on success, or an error code on failure.
 258          */
 259         int (*power_dropout)(int* power_dropout);
 260
 261         /**
 262          * Read and clear the srst asserted detection flag.
 263          *
 264          * Like power_dropout this does *not* read the current
 265          * state.  SRST assertion is transitionary and may be much
 266          * less than 1ms, so the interface driver must watch for these
 267          * events until this routine is called.
 268          *
 269          * @param srst_asserted On return, indicates whether SRST has
 270          * been asserted.
 271          * @returns ERROR_OK on success, or an error code on failure.
 272          */
 273         int (*srst_asserted)(int* srst_asserted);
 274 } jtag_interface_t;
 275
 276
 277 #endif // OPENOCD_JTAG_INTERFACE_H