git.sur5r.net Git - openocd/blob - src/jtag/jtag.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef JTAG_H
  21 #define JTAG_H
  22
  23 #include "types.h"
  24 #include "binarybuffer.h"
  25 #include "log.h"
  26
  27 #include "command.h"
  28
  29 #if 0
  30 #define _DEBUG_JTAG_IO_
  31 #endif
  32
  33 /* Tap States
  34  * TLR - Test-Logic-Reset, RTI - Run-Test/Idle,
  35  * SDS - Select-DR-Scan, CD - Capture-DR, SD - Shift-DR, E1D - Exit1-DR,
  36  * PD - Pause-DR, E2D - Exit2-DR, UD - Update-DR,
  37  * SIS - Select-IR-Scan, CI - Capture-IR, SI - Shift-IR, E1I - Exit1-IR,
  38  * PI - Pause-IR, E2I - Exit2-IR, UI - Update-IR
  39  */
  40 enum tap_state
  41 {
  42         TAP_TLR = 0x0, TAP_RTI = 0x8,
  43         TAP_SDS = 0x1, TAP_CD = 0x2, TAP_SD = 0x3, TAP_E1D = 0x4,
  44         TAP_PD = 0x5, TAP_E2D = 0x6, TAP_UD = 0x7,
  45         TAP_SIS = 0x9, TAP_CI = 0xa, TAP_SI = 0xb, TAP_E1I = 0xc,
  46         TAP_PI = 0xd, TAP_E2I = 0xe, TAP_UI = 0xf
  47 };
  48
  49 typedef struct tap_transition_s
  50 {
  51         enum tap_state high;
  52         enum tap_state low;
  53 } tap_transition_t;
  54
  55 extern char* tap_state_strings[16];
  56 extern int tap_move_map[16];    /* map 16 TAP states to 6 stable states */
  57 extern u8 tap_move[6][6];               /* value scanned to TMS to move from one of six stable states to another */
  58 extern tap_transition_t tap_transitions[16];    /* describe the TAP state diagram */
  59
  60 extern enum tap_state end_state;                /* finish DR scans in dr_end_state */
  61 extern enum tap_state cur_state;                /* current TAP state */
  62
  63 extern enum tap_state cmd_queue_end_state;              /* finish DR scans in dr_end_state */
  64 extern enum tap_state cmd_queue_cur_state;              /* current TAP state */
  65
  66 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
  67
  68 typedef void * error_handler_t; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */
  69
  70 struct scan_field_s;
  71 typedef int (*in_handler_t)(u8 *in_value, void *priv, struct scan_field_s *field);
  72
  73 typedef struct scan_field_s
  74 {
  75         int device;                     /* ordinal device number this instruction refers to */
  76         int num_bits;           /* number of bits this field specifies (up to 32) */
  77         u8 *out_value;          /* value to be scanned into the device */
  78         u8 *out_mask;           /* only masked bits care */
  79         u8 *in_value;           /* pointer to a 32-bit memory location to take data scanned out */
  80         /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage  */
  81         u8 *in_check_value;     /* used to validate scan results */
  82         u8 *in_check_mask;      /* check specified bits against check_value */
  83         in_handler_t in_handler;            /* process received buffer using this handler */
  84         void *in_handler_priv;  /* additional information for the in_handler */
  85 } scan_field_t;
  86
  87
  88 enum scan_type
  89 {
  90         /* IN: from device to host, OUT: from host to device */
  91         SCAN_IN = 1, SCAN_OUT = 2, SCAN_IO = 3
  92 };
  93
  94 typedef struct scan_command_s
  95 {
  96         int ir_scan;    /* instruction/not data scan */
  97         int num_fields;         /* number of fields in *fields array */
  98         scan_field_t *fields;   /* pointer to an array of data scan fields */
  99         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 100 } scan_command_t;
 101
 102 typedef struct statemove_command_s
 103 {
 104         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 105 } statemove_command_t;
 106
 107 typedef struct pathmove_command_s
 108 {
 109         int num_states;                         /* number of states in *path */
 110         enum tap_state *path;           /* states that have to be passed */
 111 } pathmove_command_t;
 112
 113 typedef struct runtest_command_s
 114 {
 115         int num_cycles;         /* number of cycles that should be spent in Run-Test/Idle */
 116         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 117 } runtest_command_t;
 118
 119 typedef struct reset_command_s
 120 {
 121         int trst;                       /* trst/srst 0: deassert, 1: assert, -1: don't change */
 122         int srst;
 123 } reset_command_t;
 124
 125 typedef struct end_state_command_s
 126 {
 127         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 128 } end_state_command_t;
 129
 130 typedef struct sleep_command_s
 131 {
 132         u32 us;         /* number of microseconds to sleep */
 133 } sleep_command_t;
 134
 135 typedef union jtag_command_container_u
 136 {
 137         scan_command_t *scan;
 138         statemove_command_t *statemove;
 139         pathmove_command_t *pathmove;
 140         runtest_command_t *runtest;
 141         reset_command_t *reset;
 142         end_state_command_t *end_state;
 143         sleep_command_t *sleep;
 144 } jtag_command_container_t;
 145
 146 enum jtag_command_type
 147 {
 148         JTAG_SCAN = 1,
 149         JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3,
 150         JTAG_RESET = 4, JTAG_END_STATE = 5,
 151         JTAG_PATHMOVE = 6, JTAG_SLEEP = 7
 152 };
 153
 154 typedef struct jtag_command_s
 155 {
 156         jtag_command_container_t cmd;
 157         enum jtag_command_type type;
 158         struct jtag_command_s *next;
 159 } jtag_command_t;
 160
 161 extern jtag_command_t *jtag_command_queue;
 162
 163 typedef struct jtag_device_s
 164 {
 165         int ir_length;          /* size of instruction register */
 166         u8 *expected;           /* Capture-IR expected value */
 167         u8 *expected_mask;      /* Capture-IR expected mask */
 168         u32 idcode;                     /* device identification code */
 169         u8 *cur_instr;          /* current instruction */
 170         int bypass;                     /* bypass register selected */
 171         struct jtag_device_s *next;
 172 } jtag_device_t;
 173
 174 extern jtag_device_t *jtag_devices;
 175 extern int jtag_num_devices;
 176 extern int jtag_ir_scan_size;
 177
 178 enum reset_line_mode
 179 {
 180         LINE_OPEN_DRAIN = 0x0,
 181         LINE_PUSH_PULL = 0x1,
 182 };
 183
 184 typedef struct jtag_interface_s
 185 {
 186         char* name;
 187
 188         /* queued command execution
 189          */
 190         int (*execute_queue)(void);
 191
 192         /* interface initalization
 193          */
 194         int (*speed)(int speed);
 195         int (*register_commands)(struct command_context_s *cmd_ctx);
 196         int (*init)(void);
 197         int (*quit)(void);
 198         /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
 199         a failure if it can't support the KHz/RTCK. */
 200         int (*khz)(int khz, int *jtag_speed);
 201         /* returns the KHz for the provided JTAG speed. 0=RTCK. The function returns
 202         a failure if it can't support the KHz/RTCK. */
 203         int (*speed_div)(int speed, int *khz);
 204
 205 } jtag_interface_t;
 206
 207 enum jtag_event
 208 {
 209         JTAG_TRST_ASSERTED
 210 };
 211
 212 extern char* jtag_event_strings[];
 213
 214 extern int jtag_trst;
 215 extern int jtag_srst;
 216
 217 typedef struct jtag_event_callback_s
 218 {
 219         int (*callback)(enum jtag_event event, void *priv);
 220         void *priv;
 221         struct jtag_event_callback_s *next;
 222 } jtag_event_callback_t;
 223
 224 extern jtag_event_callback_t *jtag_event_callbacks;
 225
 226 extern jtag_interface_t *jtag;  /* global pointer to configured JTAG interface */
 227 extern enum tap_state end_state;
 228 extern enum tap_state cur_state;
 229
 230 extern int jtag_speed;
 231 extern int jtag_speed_post_reset;
 232
 233 enum reset_types
 234 {
 235         RESET_NONE = 0x0,
 236         RESET_HAS_TRST = 0x1,
 237         RESET_HAS_SRST = 0x2,
 238         RESET_TRST_AND_SRST = 0x3,
 239         RESET_SRST_PULLS_TRST = 0x4,
 240         RESET_TRST_PULLS_SRST = 0x8,
 241         RESET_TRST_OPEN_DRAIN = 0x10,
 242         RESET_SRST_PUSH_PULL = 0x20,
 243 };
 244
 245 extern enum reset_types jtag_reset_config;
 246
 247 /* initialize interface upon startup. A successful no-op
 248  * upon subsequent invocations
 249  */
 250 extern int jtag_interface_init(struct command_context_s *cmd_ctx);
 251 /* initialize JTAG chain using only a TLR reset. If init fails,
 252  * try reset + init.
 253  */
 254 extern int jtag_init(struct command_context_s *cmd_ctx);
 255 /* reset, then initialize JTAG chain */
 256 extern int jtag_init_reset(struct command_context_s *cmd_ctx);
 257 extern int jtag_register_commands(struct command_context_s *cmd_ctx);
 258
 259 /* JTAG interface, can be implemented with a software or hardware fifo
 260  *
 261  * TAP_SD and TAP_SI are illegal end states. TAP_SD/SI as end states
 262  * can be emulated by using a larger scan.
 263  *
 264  * Code that is relatively insensitive to the path(as long
 265  * as it is JTAG compliant) taken through state machine can use
 266  * endstate for jtag_add_xxx_scan(). Otherwise the pause state must be
 267  * specified as end state and a subsequent jtag_add_pathmove() must
 268  * be issued.
 269  *
 270  */
 271 extern void jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 272 extern int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 273 extern void jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 274 extern int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 275 extern void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 276 extern int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 277 extern void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 278 extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 279 /* run a TAP_TLR reset. End state is TAP_TLR, regardless
 280  * of start state.
 281  */
 282 extern void jtag_add_tlr();
 283 extern int interface_jtag_add_tlr();
 284 /* Do not use jtag_add_pathmove() unless you need to, but do use it
 285  * if you have to.
 286  *
 287  * DANGER! If the target is dependent upon a particular sequence
 288  * of transitions for things to work correctly(e.g. as a workaround
 289  * for an errata that contradicts the JTAG standard), then pathmove
 290  * must be used, even if some jtag interfaces happen to use the
 291  * desired path. Worse, the jtag interface used for testing a
 292  * particular implementation, could happen to use the "desired"
 293  * path when transitioning to/from end
 294  * state.
 295  *
 296  * A list of unambigious single clock state transitions, not
 297  * all drivers can support this, but it is required for e.g.
 298  * XScale and Xilinx support
 299  *
 300  * Note! TAP_TLR must not be used in the path!
 301  *
 302  * Note that the first on the list must be reachable
 303  * via a single transition from the current state.
 304  *
 305  * All drivers are required to implement jtag_add_pathmove().
 306  * However, if the pathmove sequence can not be precisely
 307  * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
 308  * must return an error. It is legal, but not recommended, that
 309  * a driver returns an error in all cases for a pathmove if it
 310  * can only implement a few transitions and therefore
 311  * a partial implementation of pathmove would have little practical
 312  * application.
 313  */
 314 extern void jtag_add_pathmove(int num_states, enum tap_state *path);
 315 extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path);
 316 /* go to TAP_RTI, if we're not already there and cycle
 317  * precisely num_cycles in the TAP_RTI after which move
 318  * to the end state, if it is != TAP_RTI
 319  */
 320 extern void jtag_add_runtest(int num_cycles, enum tap_state endstate);
 321 extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate);
 322 /* A reset of the TAP state machine can be requested.
 323  *
 324  * Whether tms or trst reset is used depends on the capabilities of
 325  * the target and jtag interface(reset_config  command configures this).
 326  *
 327  * srst can driver a reset of the TAP state machine and vice
 328  * versa
 329  *
 330  * Application code may need to examine value of jtag_reset_config
 331  * to determine the proper codepath
 332  *
 333  * DANGER! Even though srst drives trst, trst might not be connected to
 334  * the interface, and it might actually be *harmful* to assert trst in this case.
 335  *
 336  * This is why combinations such as "reset_config srst_only srst_pulls_trst"
 337  * are supported.
 338  *
 339  * only req_tlr_or_trst and srst can have a transition for a
 340  * call as the effects of transitioning both at the "same time"
 341  * are undefined, but when srst_pulls_trst or vice versa,
 342  * then trst & srst *must* be asserted together.
 343  */
 344 extern void jtag_add_reset(int req_tlr_or_trst, int srst);
 345 /* this drives the actual srst and trst pins. srst will always be 0
 346  * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for
 347  * trst.
 348  *
 349  * the higher level jtag_add_reset will invoke jtag_add_tlr() if
 350  * approperiate
 351  */
 352 extern int interface_jtag_add_reset(int trst, int srst);
 353 extern void jtag_add_end_state(enum tap_state endstate);
 354 extern int interface_jtag_add_end_state(enum tap_state endstate);
 355 extern void jtag_add_sleep(u32 us);
 356 extern int interface_jtag_add_sleep(u32 us);
 357
 358
 359
 360 /*
 361  * For software FIFO implementations, the queued commands can be executed
 362  * during this call or earlier. A sw queue might decide to push out
 363  * some of the jtag_add_xxx() operations once the queue is "big enough".
 364  *
 365  * This fn will return an error code if any of the prior jtag_add_xxx()
 366  * calls caused a failure, e.g. check failure. Note that it does not
 367  * matter if the operation was executed *before* jtag_execute_queue(),
 368  * jtag_execute_queue() will still return an error code.
 369  *
 370  * All jtag_add_xxx() calls that have in_handler!=NULL will have been
 371  * executed when this fn returns, but if what has been queued only
 372  * clocks data out, without reading anything back, then JTAG could
 373  * be running *after* jtag_execute_queue() returns. The API does
 374  * not define a way to flush a hw FIFO that runs *after*
 375  * jtag_execute_queue() returns.
 376  *
 377  * jtag_add_xxx() commands can either be executed immediately or
 378  * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
 379  */
 380 extern int jtag_execute_queue(void);
 381 /* can be implemented by hw+sw */
 382 extern int interface_jtag_execute_queue(void);
 383
 384 /* JTAG support functions */
 385 extern void jtag_set_check_value(scan_field_t *field, u8 *value,  u8 *mask, error_handler_t *in_error_handler);
 386 extern enum scan_type jtag_scan_type(scan_command_t *cmd);
 387 extern int jtag_scan_size(scan_command_t *cmd);
 388 extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd);
 389 extern int jtag_build_buffer(scan_command_t *cmd, u8 **buffer);
 390 extern jtag_device_t* jtag_get_device(int num);
 391 extern void jtag_sleep(u32 us);
 392 extern int jtag_call_event_callbacks(enum jtag_event event);
 393 extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv);
 394
 395 extern int jtag_verify_capture_ir;
 396
 397 /* error codes
 398  * JTAG subsystem uses codes between -100 and -199 */
 399
 400 #define ERROR_JTAG_INIT_FAILED                  (-100)
 401 #define ERROR_JTAG_INVALID_INTERFACE    (-101)
 402 #define ERROR_JTAG_NOT_IMPLEMENTED              (-102)
 403 #define ERROR_JTAG_TRST_ASSERTED                (-103)
 404 #define ERROR_JTAG_QUEUE_FAILED                 (-104)
 405 #define ERROR_JTAG_DEVICE_ERROR                 (-107)
 406
 407
 408
 409 /* this allows JTAG devices to implement the entire jtag_xxx() layer in hw/sw */
 410 #ifdef HAVE_JTAG_MINIDRIVER_H
 411 /* Here a #define MINIDRIVER() and an inline version of hw fifo interface_jtag_add_dr_out can be defined */
 412 #include "jtag_minidriver.h"
 413 #define MINIDRIVER(a) notused ## a
 414 #else
 415 #define MINIDRIVER(a) a
 416 /* jtag_add_dr_out() is a faster version of jtag_add_dr_scan()
 417  *
 418  * Current or end_state can not be TAP_TLR. end_state can be -1
 419  *
 420  * num_bits[i] is the number of bits to clock out from value[i] LSB first.
 421  *
 422  * If the device is in bypass, then that is an error condition in
 423  * the caller code that is not detected by this fn, whereas jtag_add_dr_scan()
 424  * does detect it. Similarly if the device is not in bypass, data must
 425  * be passed to it.
 426  *
 427  * If anything fails, then jtag_error will be set and jtag_execute() will
 428  * return an error. There is no way to determine if there was a failure
 429  * during this function call.
 430  *
 431  * Note that this jtag_add_dr_out can be defined as an inline function.
 432  */
 433 extern void interface_jtag_add_dr_out(int device,
 434                 int num_fields,
 435                 int *num_bits,
 436                 u32 *value,
 437                 enum tap_state end_state);
 438 #endif
 439
 440
 441
 442
 443 static __inline__ void jtag_add_dr_out(int device,
 444                 int num_fields,
 445                 int *num_bits,
 446                 u32 *value,
 447                 enum tap_state end_state)
 448 {
 449         if (end_state != -1)
 450                 cmd_queue_end_state=end_state;
 451         cmd_queue_cur_state=cmd_queue_end_state;
 452         interface_jtag_add_dr_out(device, num_fields, num_bits, value, cmd_queue_end_state);
 453 }
 454
 455
 456 #endif /* JTAG_H */