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
  26 #include "command.h"
  27
  28 #if 0
  29 #define _DEBUG_JTAG_IO_
  30 #endif
  31
  32 /* Tap States
  33  * TLR - Test-Logic-Reset, RTI - Run-Test/Idle,
  34  * SDS - Select-DR-Scan, CD - Capture-DR, SD - Shift-DR, E1D - Exit1-DR,
  35  * PD - Pause-DR, E2D - Exit2-DR, UD - Update-DR,
  36  * SIS - Select-IR-Scan, CI - Capture-IR, SI - Shift-IR, E1I - Exit1-IR,
  37  * PI - Pause-IR, E2I - Exit2-IR, UI - Update-IR
  38  */
  39 enum tap_state
  40 {
  41         TAP_TLR = 0x0, TAP_RTI = 0x8,
  42         TAP_SDS = 0x1, TAP_CD = 0x2, TAP_SD = 0x3, TAP_E1D = 0x4,
  43         TAP_PD = 0x5, TAP_E2D = 0x6, TAP_UD = 0x7,
  44         TAP_SIS = 0x9, TAP_CI = 0xa, TAP_SI = 0xb, TAP_E1I = 0xc,
  45         TAP_PI = 0xd, TAP_E2I = 0xe, TAP_UI = 0xf
  46 };
  47
  48 typedef struct tap_transition_s
  49 {
  50         enum tap_state high;
  51         enum tap_state low;
  52 } tap_transition_t;
  53
  54 extern char* tap_state_strings[16];
  55 extern int tap_move_map[16];    /* map 16 TAP states to 6 stable states */
  56 extern u8 tap_move[6][6];               /* value scanned to TMS to move from one of six stable states to another */
  57 extern tap_transition_t tap_transitions[16];    /* describe the TAP state diagram */
  58
  59 extern enum tap_state end_state;                /* finish DR scans in dr_end_state */
  60 extern enum tap_state cur_state;                /* current TAP state */
  61
  62 extern enum tap_state cmd_queue_end_state;              /* finish DR scans in dr_end_state */
  63 extern enum tap_state cmd_queue_cur_state;              /* current TAP state */
  64
  65 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
  66
  67 typedef void * error_handler_t; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */
  68
  69 struct scan_field_s;
  70 typedef int (*in_handler_t)(u8 *in_value, void *priv, struct scan_field_s *field);
  71
  72 typedef struct scan_field_s
  73 {
  74         int device;                     /* ordinal device number this instruction refers to */
  75         int num_bits;           /* number of bits this field specifies (up to 32) */
  76         u8 *out_value;          /* value to be scanned into the device */
  77         u8 *out_mask;           /* only masked bits care */
  78         u8 *in_value;           /* pointer to a 32-bit memory location to take data scanned out */
  79         /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage  */
  80         u8 *in_check_value;     /* used to validate scan results */
  81         u8 *in_check_mask;      /* check specified bits against check_value */
  82         in_handler_t in_handler;            /* process received buffer using this handler */
  83         void *in_handler_priv;  /* additional information for the in_handler */
  84 } scan_field_t;
  85
  86
  87 enum scan_type
  88 {
  89         /* IN: from device to host, OUT: from host to device */
  90         SCAN_IN = 1, SCAN_OUT = 2, SCAN_IO = 3
  91 };
  92
  93 typedef struct scan_command_s
  94 {
  95         int ir_scan;    /* instruction/not data scan */
  96         int num_fields;         /* number of fields in *fields array */
  97         scan_field_t *fields;   /* pointer to an array of data scan fields */
  98         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
  99 } scan_command_t;
 100
 101 typedef struct statemove_command_s
 102 {
 103         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 104 } statemove_command_t;
 105
 106 typedef struct pathmove_command_s
 107 {
 108         int num_states;                         /* number of states in *path */
 109         enum tap_state *path;           /* states that have to be passed */
 110 } pathmove_command_t;
 111
 112 typedef struct runtest_command_s
 113 {
 114         int num_cycles;         /* number of cycles that should be spent in Run-Test/Idle */
 115         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 116 } runtest_command_t;
 117
 118 typedef struct reset_command_s
 119 {
 120         int trst;                       /* trst/srst 0: deassert, 1: assert, -1: don't change */
 121         int srst;
 122 } reset_command_t;
 123
 124 typedef struct end_state_command_s
 125 {
 126         enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 127 } end_state_command_t;
 128
 129 typedef struct sleep_command_s
 130 {
 131         u32 us;         /* number of microseconds to sleep */
 132 } sleep_command_t;
 133
 134 typedef union jtag_command_container_u
 135 {
 136         scan_command_t *scan;
 137         statemove_command_t *statemove;
 138         pathmove_command_t *pathmove;
 139         runtest_command_t *runtest;
 140         reset_command_t *reset;
 141         end_state_command_t *end_state;
 142         sleep_command_t *sleep;
 143 } jtag_command_container_t;
 144
 145 enum jtag_command_type
 146 {
 147         JTAG_SCAN = 1,
 148         JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3,
 149         JTAG_RESET = 4, JTAG_END_STATE = 5,
 150         JTAG_PATHMOVE = 6, JTAG_SLEEP = 7
 151 };
 152
 153 typedef struct jtag_command_s
 154 {
 155         jtag_command_container_t cmd;
 156         enum jtag_command_type type;
 157         struct jtag_command_s *next;
 158 } jtag_command_t;
 159
 160 extern jtag_command_t *jtag_command_queue;
 161
 162 typedef struct jtag_device_s
 163 {
 164         int ir_length;          /* size of instruction register */
 165         u8 *expected;           /* Capture-IR expected value */
 166         u8 *expected_mask;      /* Capture-IR expected mask */
 167         u32 idcode;                     /* device identification code */
 168         u8 *cur_instr;          /* current instruction */
 169         int bypass;                     /* bypass register selected */
 170         struct jtag_device_s *next;
 171 } jtag_device_t;
 172
 173 extern jtag_device_t *jtag_devices;
 174 extern int jtag_num_devices;
 175 extern int jtag_ir_scan_size;
 176
 177 enum reset_line_mode
 178 {
 179         LINE_OPEN_DRAIN = 0x0,
 180         LINE_PUSH_PULL = 0x1,
 181 };
 182
 183 typedef struct jtag_interface_s
 184 {
 185         char* name;
 186
 187         /* queued command execution
 188          */
 189         int (*execute_queue)(void);
 190
 191         /* interface initalization
 192          */
 193         int (*speed)(int speed);
 194         int (*register_commands)(struct command_context_s *cmd_ctx);
 195         int (*init)(void);
 196         int (*quit)(void);
 197
 198 } jtag_interface_t;
 199
 200 enum jtag_event
 201 {
 202         JTAG_SRST_ASSERTED,
 203         JTAG_TRST_ASSERTED,
 204         JTAG_SRST_RELEASED,
 205         JTAG_TRST_RELEASED,
 206 };
 207
 208 extern char* jtag_event_strings[];
 209
 210 extern int jtag_trst;
 211 extern int jtag_srst;
 212
 213 typedef struct jtag_event_callback_s
 214 {
 215         int (*callback)(enum jtag_event event, void *priv);
 216         void *priv;
 217         struct jtag_event_callback_s *next;
 218 } jtag_event_callback_t;
 219
 220 extern jtag_event_callback_t *jtag_event_callbacks;
 221
 222 extern jtag_interface_t *jtag;  /* global pointer to configured JTAG interface */
 223 extern enum tap_state end_state;
 224 extern enum tap_state cur_state;
 225
 226 extern int jtag_speed;
 227
 228 enum reset_types
 229 {
 230         RESET_NONE = 0x0,
 231         RESET_HAS_TRST = 0x1,
 232         RESET_HAS_SRST = 0x2,
 233         RESET_TRST_AND_SRST = 0x3,
 234         RESET_SRST_PULLS_TRST = 0x4,
 235         RESET_TRST_PULLS_SRST = 0x8,
 236         RESET_TRST_OPEN_DRAIN = 0x10,
 237         RESET_SRST_PUSH_PULL = 0x20,
 238 };
 239
 240 extern enum reset_types jtag_reset_config;
 241
 242 /* JTAG subsystem */
 243 extern int jtag_init(struct command_context_s *cmd_ctx);
 244 extern int jtag_register_commands(struct command_context_s *cmd_ctx);
 245
 246 /* JTAG interface, can be implemented with a software or hardware fifo */
 247 extern int jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 248 extern int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 249 extern int jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 250 extern int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 251 extern int jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 252 extern int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 253 extern int jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 254 extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 255 /* execute a state transition within the JTAG standard, but the exact path
 256  * path that is taken is undefined. Many implementations use precisely
 257  * 7 clocks to perform a transition, but it could be more or less
 258  * than that.
 259  *
 260  * The following assertions are made about certain common state moves:
 261  *
 262  * - A state move from Pause-[ID]R to Pause-[ID]R should always go through
 263  *   Update-[ID]R and Capture-[ID]R before returning to Pause-[ID]R, otherwise
 264  *   there's no way force a register update, if you can't go to Run-Test/Idle for
 265  *   some reason.
 266  *
 267  *   - A state move from Pause-[ID]R to Shift-[ID]R must not go through
 268  *   Update-[ID]R.
 269  *
 270  *   - Run-Test/Idle must not be entered unless requested, because R-T/I may have
 271  *   side effects.
 272  */
 273 extern int jtag_add_statemove(enum tap_state endstate);
 274 extern int interface_jtag_add_statemove(enum tap_state endstate);
 275 /* A list of unambigious single clock state transitions, not
 276  * all drivers can support this, but it is required for e.g.
 277  * XScale and Xilinx support
 278  *
 279  * Note! TAP_TLR must not be used in the path!
 280  */
 281 extern int jtag_add_pathmove(int num_states, enum tap_state *path);
 282 extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path);
 283 /* cycle precisely num_cycles in the TAP_RTI state */
 284 extern int jtag_add_runtest(int num_cycles, enum tap_state endstate);
 285 extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate);
 286 extern int jtag_add_reset(int trst, int srst);
 287 extern int interface_jtag_add_reset(int trst, int srst);
 288 extern int jtag_add_end_state(enum tap_state endstate);
 289 extern int interface_jtag_add_end_state(enum tap_state endstate);
 290 extern int jtag_add_sleep(u32 us);
 291 extern int interface_jtag_add_sleep(u32 us);
 292 /*
 293  * For software FIFO implementations, the queued commands can be executed
 294  * during this call or earlier. A sw queue might decide to push out
 295  * some of the jtag_add_xxx() operations once the queue is "big enough".
 296  *
 297  * This fn will return an error code if any of the prior jtag_add_xxx()
 298  * calls caused a failure, e.g. check failure. Note that it does not
 299  * matter if the operation was executed *before* jtag_execute_queue(),
 300  * jtag_execute_queue() will still return an error code.
 301  *
 302  * All jtag_add_xxx() calls that have in_handler!=NULL will have been
 303  * executed when this fn returns, but if what has been queued only
 304  * clocks data out, without reading anything back, then JTAG could
 305  * be running *after* jtag_execute_queue() returns. The API does
 306  * not define a way to flush a hw FIFO that runs *after*
 307  * jtag_execute_queue() returns.
 308  *
 309  * jtag_add_xxx() commands can either be executed immediately or
 310  * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
 311  */
 312 extern int jtag_execute_queue(void);
 313 /* can be implemented by hw+sw */
 314 extern int interface_jtag_execute_queue(void);
 315
 316 /* JTAG support functions */
 317 extern void jtag_set_check_value(scan_field_t *field, u8 *value,  u8 *mask, error_handler_t *in_error_handler);
 318 extern enum scan_type jtag_scan_type(scan_command_t *cmd);
 319 extern int jtag_scan_size(scan_command_t *cmd);
 320 extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd);
 321 extern int jtag_build_buffer(scan_command_t *cmd, u8 **buffer);
 322 extern jtag_device_t* jtag_get_device(int num);
 323 extern void jtag_sleep(u32 us);
 324 extern int jtag_call_event_callbacks(enum jtag_event event);
 325 extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv);
 326
 327 extern int jtag_verify_capture_ir;
 328
 329
 330 /* error codes
 331  * JTAG subsystem uses codes between -100 and -199 */
 332
 333 #define ERROR_JTAG_INIT_FAILED                  (-100)
 334 #define ERROR_JTAG_INVALID_INTERFACE    (-101)
 335 #define ERROR_JTAG_NOT_IMPLEMENTED              (-102)
 336 #define ERROR_JTAG_TRST_ASSERTED                (-103)
 337 #define ERROR_JTAG_QUEUE_FAILED                 (-104)
 338 #define ERROR_JTAG_RESET_WOULD_ASSERT_TRST              (-105)
 339 #define ERROR_JTAG_RESET_CANT_SRST                              (-106)
 340 #define ERROR_JTAG_DEVICE_ERROR                 (-107)
 341
 342
 343 #endif /* JTAG_H */