X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fjtag%2Fjtag.h;h=e2b613615f04ca25931634099cc12ceb44491f47;hp=68f52dde7280c275b7226d0ee898601927b8b2b5;hb=814183a5c41cad14b83c29c9473084e6d1a11d9b;hpb=bbafcb3758ac315b94ac54e88ab2dafe8377e062 diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h index 68f52dde72..1dae00fa31 100644 --- a/src/jtag/jtag.h +++ b/src/jtag/jtag.h @@ -1,314 +1,500 @@ /*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007,2008 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program; if not, write to the * - * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - ***************************************************************************/ +* Copyright (C) 2005 by Dominic Rath * +* Dominic.Rath@gmx.de * +* * +* Copyright (C) 2007,2008 Øyvind Harboe * +* oyvind.harboe@zylin.com * +* * +* This program is free software; you can redistribute it and/or modify * +* it under the terms of the GNU General Public License as published by * +* the Free Software Foundation; either version 2 of the License, or * +* (at your option) any later version. * +* * +* This program is distributed in the hope that it will be useful, * +* but WITHOUT ANY WARRANTY; without even the implied warranty of * +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * +* GNU General Public License for more details. * +* * +* You should have received a copy of the GNU General Public License * +* along with this program; if not, write to the * +* Free Software Foundation, Inc., * +* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * +***************************************************************************/ #ifndef JTAG_H #define JTAG_H -#include "types.h" #include "binarybuffer.h" #include "log.h" -#include "command.h" -#if 0 -#define _DEBUG_JTAG_IO_ +#ifdef _DEBUG_JTAG_IO_ +#define DEBUG_JTAG_IO(expr ...) \ + do { if (1) LOG_DEBUG(expr); } while (0) +#else +#define DEBUG_JTAG_IO(expr ...) \ + do { if (0) LOG_DEBUG(expr); } while (0) #endif -/* Tap States - * TLR - Test-Logic-Reset, RTI - Run-Test/Idle, - * SDS - Select-DR-Scan, CD - Capture-DR, SD - Shift-DR, E1D - Exit1-DR, - * PD - Pause-DR, E2D - Exit2-DR, UD - Update-DR, - * SIS - Select-IR-Scan, CI - Capture-IR, SI - Shift-IR, E1I - Exit1-IR, - * PI - Pause-IR, E2I - Exit2-IR, UI - Update-IR - */ -enum tap_state -{ - TAP_TLR = 0x0, TAP_RTI = 0x8, - TAP_SDS = 0x1, TAP_CD = 0x2, TAP_SD = 0x3, TAP_E1D = 0x4, - TAP_PD = 0x5, TAP_E2D = 0x6, TAP_UD = 0x7, - TAP_SIS = 0x9, TAP_CI = 0xa, TAP_SI = 0xb, TAP_E1I = 0xc, - TAP_PI = 0xd, TAP_E2I = 0xe, TAP_UI = 0xf -}; +#ifndef DEBUG_JTAG_IOZ +#define DEBUG_JTAG_IOZ 64 +#endif -typedef struct tap_transition_s -{ - enum tap_state high; - enum tap_state low; -} tap_transition_t; +/*-------------------------------------------------------*/ -extern char* tap_state_strings[16]; -extern int tap_move_map[16]; /* map 16 TAP states to 6 stable states */ -extern u8 tap_move[6][6]; /* value scanned to TMS to move from one of six stable states to another */ -extern tap_transition_t tap_transitions[16]; /* describe the TAP state diagram */ +/** + * When given an array, compute its DIMension; in other words, the + * number of elements in the array + */ +#define DIM(x) (sizeof(x)/sizeof((x)[0])) -extern enum tap_state end_state; /* finish DR scans in dr_end_state */ -extern enum tap_state cur_state; /* current TAP state */ +/** Calculate the number of bytes required to hold @a n TAP scan bits */ +#define TAP_SCAN_BYTES(n) CEIL(n, 8) -extern enum tap_state cmd_queue_end_state; /* finish DR scans in dr_end_state */ -extern enum tap_state cmd_queue_cur_state; /* current TAP state */ +/*------------------------------------------------------*/ -#define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]] +/** + * Defines JTAG Test Access Port states. + * + * These definitions were gleaned from the ARM7TDMI-S Technical + * Reference Manual and validated against several other ARM core + * technical manuals. tap_get_tms_path() is sensitive to this numbering + * and ordering of the TAP states; furthermore, some interfaces require + * specific numbers be used, as they are handed-off directly to their + * hardware implementations. + */ +typedef enum tap_state +{ +#if BUILD_ZY1000 + /* These are the old numbers. Leave as-is for now... */ + TAP_RESET = 0, TAP_IDLE = 8, + TAP_DRSELECT = 1, TAP_DRCAPTURE = 2, TAP_DRSHIFT = 3, TAP_DREXIT1 = 4, + TAP_DRPAUSE = 5, TAP_DREXIT2 = 6, TAP_DRUPDATE = 7, + TAP_IRSELECT = 9, TAP_IRCAPTURE = 10, TAP_IRSHIFT = 11, TAP_IREXIT1 = 12, + TAP_IRPAUSE = 13, TAP_IREXIT2 = 14, TAP_IRUPDATE = 15, + + TAP_NUM_STATES = 16, TAP_INVALID = -1, +#else + /* Proper ARM recommended numbers */ + TAP_DREXIT2 = 0x0, + TAP_DREXIT1 = 0x1, + TAP_DRSHIFT = 0x2, + TAP_DRPAUSE = 0x3, + TAP_IRSELECT = 0x4, + TAP_DRUPDATE = 0x5, + TAP_DRCAPTURE = 0x6, + TAP_DRSELECT = 0x7, + TAP_IREXIT2 = 0x8, + TAP_IREXIT1 = 0x9, + TAP_IRSHIFT = 0xa, + TAP_IRPAUSE = 0xb, + TAP_IDLE = 0xc, + TAP_IRUPDATE = 0xd, + TAP_IRCAPTURE = 0xe, + TAP_RESET = 0x0f, + + TAP_NUM_STATES = 0x10, + + TAP_INVALID = -1, +#endif +} tap_state_t; + +/** + * Function tap_state_name + * Returns a string suitable for display representing the JTAG tap_state + */ +const char *tap_state_name(tap_state_t state); -typedef void * error_handler_t; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */ +/// Provides user-friendly name lookup of TAP states. +tap_state_t tap_state_by_name(const char *name); -struct scan_field_s; -typedef int (*in_handler_t)(u8 *in_value, void *priv, struct scan_field_s *field); +/// The current TAP state of the pending JTAG command queue. +extern tap_state_t cmd_queue_cur_state; +/** + * This structure defines a single scan field in the scan. It provides + * fields for the field's width and pointers to scan input and output + * values. + * + * In addition, this structure includes a value and mask that is used by + * jtag_add_dr_scan_check() to validate the value that was scanned out. + * + * The allocated, modified, and intmp fields are internal work space. + */ typedef struct scan_field_s { - int device; /* ordinal device number this instruction refers to */ - int num_bits; /* number of bits this field specifies (up to 32) */ - u8 *out_value; /* value to be scanned into the device */ - u8 *out_mask; /* only masked bits care */ - u8 *in_value; /* pointer to a 32-bit memory location to take data scanned out */ - /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage */ - u8 *in_check_value; /* used to validate scan results */ - u8 *in_check_mask; /* check specified bits against check_value */ - in_handler_t in_handler; /* process received buffer using this handler */ - void *in_handler_priv; /* additional information for the in_handler */ + /// A pointer to the tap structure to which this field refers. + jtag_tap_t* tap; + + /// The number of bits this field specifies (up to 32) + int num_bits; + /// A pointer to value to be scanned into the device + uint8_t* out_value; + /// A pointer to a 32-bit memory location for data scanned out + uint8_t* in_value; + + /// The value used to check the data scanned out. + uint8_t* check_value; + /// The mask to go with check_value + uint8_t* check_mask; + + /// in_value has been allocated for the queue + int allocated; + /// Indicates we modified the in_value. + int modified; + /// temporary storage for performing value checks synchronously + uint8_t intmp[4]; } scan_field_t; +typedef struct jtag_tap_event_action_s jtag_tap_event_action_t; -enum scan_type +/* this is really: typedef jtag_tap_t */ +/* But - the typedef is done in "types.h" */ +/* due to "forward declaration reasons" */ +struct jtag_tap_s { - /* IN: from device to host, OUT: from host to device */ - SCAN_IN = 1, SCAN_OUT = 2, SCAN_IO = 3 + const char* chip; + const char* tapname; + const char* dotted_name; + int abs_chain_position; + /// Is this TAP disabled after JTAG reset? + bool disabled_after_reset; + /// Is this TAP currently enabled? + bool enabled; + int ir_length; /**< size of instruction register */ + uint32_t ir_capture_value; + uint8_t* expected; /**< Capture-IR expected value */ + uint32_t ir_capture_mask; + uint8_t* expected_mask; /**< Capture-IR expected mask */ + uint32_t idcode; + bool hasidcode; /* not all devices have idcode, we'll discover this during chain examination */ + /**< device identification code */ + + /// Array of expected identification codes */ + uint32_t* expected_ids; + /// Number of expected identification codes + uint8_t expected_ids_cnt; + + /// current instruction + uint8_t* cur_instr; + /// Bypass register selected + int bypass; + + jtag_tap_event_action_t *event_action; + + jtag_tap_t* next_tap; }; -typedef struct scan_command_s -{ - int ir_scan; /* instruction/not data scan */ - int num_fields; /* number of fields in *fields array */ - scan_field_t *fields; /* pointer to an array of data scan fields */ - enum tap_state end_state; /* TAP state in which JTAG commands should finish */ -} scan_command_t; +void jtag_tap_init(jtag_tap_t *tap); +void jtag_tap_free(jtag_tap_t *tap); -typedef struct statemove_command_s -{ - enum tap_state end_state; /* TAP state in which JTAG commands should finish */ -} statemove_command_t; +extern jtag_tap_t* jtag_all_taps(void); +extern const char *jtag_tap_name(const jtag_tap_t *tap); +extern jtag_tap_t* jtag_tap_by_string(const char* dotted_name); +extern jtag_tap_t* jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj* obj); +extern jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p); +extern unsigned jtag_tap_count_enabled(void); +extern unsigned jtag_tap_count(void); -typedef struct pathmove_command_s -{ - int num_states; /* number of states in *path */ - enum tap_state *path; /* states that have to be passed */ -} pathmove_command_t; -typedef struct runtest_command_s -{ - int num_cycles; /* number of cycles that should be spent in Run-Test/Idle */ - enum tap_state end_state; /* TAP state in which JTAG commands should finish */ -} runtest_command_t; +/* + * - TRST_ASSERTED triggers two sets of callbacks, after operations to + * reset the scan chain -- via TMS+TCK signaling, or deasserting the + * nTRST signal -- are queued: + * + * + Callbacks in C code fire first, patching internal state + * + Then post-reset event scripts fire ... activating JTAG circuits + * via TCK cycles, exiting SWD mode via TMS sequences, etc + * + * During those callbacks, scan chain contents have not been validated. + * JTAG operations that address a specific TAP (primarily DR/IR scans) + * must *not* be queued. + * + * - TAP_EVENT_SETUP is reported after TRST_ASSERTED, and after the scan + * chain has been validated. JTAG operations including scans that + * target specific TAPs may be performed. + * + * - TAP_EVENT_ENABLE and TAP_EVENT_DISABLE implement TAP activation and + * deactivation outside the core using scripted code that understands + * the specific JTAG router type. They might be triggered indirectly + * from EVENT_SETUP operations. + */ +enum jtag_event { + JTAG_TRST_ASSERTED, + JTAG_TAP_EVENT_SETUP, + JTAG_TAP_EVENT_ENABLE, + JTAG_TAP_EVENT_DISABLE, +}; -typedef struct reset_command_s +struct jtag_tap_event_action_s { - int trst; /* trst/srst 0: deassert, 1: assert, -1: don't change */ - int srst; -} reset_command_t; + enum jtag_event event; + Jim_Obj* body; + jtag_tap_event_action_t* next; +}; -typedef struct end_state_command_s -{ - enum tap_state end_state; /* TAP state in which JTAG commands should finish */ -} end_state_command_t; +/** + * Defines the function signature requide for JTAG event callback + * functions, which are added with jtag_register_event_callback() + * and removed jtag_unregister_event_callback(). + * @param event The event to handle. + * @param prive A pointer to data that was passed to + * jtag_register_event_callback(). + * @returns Must return ERROR_OK on success, or an error code on failure. + * + * @todo Change to return void or define a use for its return code. + */ +typedef int (*jtag_event_handler_t)(enum jtag_event event, void* priv); -typedef struct sleep_command_s -{ - u32 us; /* number of microseconds to sleep */ -} sleep_command_t; +extern int jtag_register_event_callback(jtag_event_handler_t f, void *x); +extern int jtag_unregister_event_callback(jtag_event_handler_t f, void *x); -typedef union jtag_command_container_u -{ - scan_command_t *scan; - statemove_command_t *statemove; - pathmove_command_t *pathmove; - runtest_command_t *runtest; - reset_command_t *reset; - end_state_command_t *end_state; - sleep_command_t *sleep; -} jtag_command_container_t; - -enum jtag_command_type -{ - JTAG_SCAN = 1, - JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3, - JTAG_RESET = 4, JTAG_END_STATE = 5, - JTAG_PATHMOVE = 6, JTAG_SLEEP = 7 -}; +extern int jtag_call_event_callbacks(enum jtag_event event); -typedef struct jtag_command_s -{ - jtag_command_container_t cmd; - enum jtag_command_type type; - struct jtag_command_s *next; -} jtag_command_t; -extern jtag_command_t *jtag_command_queue; +/// @returns The current JTAG speed setting. +int jtag_get_speed(void); +/** + * Given a @a speed setting, use the interface @c speed_div callback to + * adjust the setting. + * @param speed The speed setting to convert back to readable KHz. + * @returns ERROR_OK if the interface has not been initialized or on success; + * otherwise, the error code produced by the @c speed_div callback. + */ +int jtag_get_speed_readable(int *speed); +/** + * Set the JTAG speed. This routine will call the underlying + * interface @c speed callback, if the interface has been initialized. + * @param speed The new speed setting. + * @returns ERROR_OK during configuration or on success, or an error + * code returned from the interface @c speed callback. + */ +int jtag_config_speed(int speed); -typedef struct jtag_device_s -{ - int ir_length; /* size of instruction register */ - u8 *expected; /* Capture-IR expected value */ - u8 *expected_mask; /* Capture-IR expected mask */ - u32 idcode; /* device identification code */ - u8 *cur_instr; /* current instruction */ - int bypass; /* bypass register selected */ - struct jtag_device_s *next; -} jtag_device_t; - -extern jtag_device_t *jtag_devices; -extern int jtag_num_devices; -extern int jtag_ir_scan_size; - -enum reset_line_mode -{ - LINE_OPEN_DRAIN = 0x0, - LINE_PUSH_PULL = 0x1, -}; -typedef struct jtag_interface_s -{ - char* name; - - /* queued command execution - */ - int (*execute_queue)(void); - - /* interface initalization - */ - int (*speed)(int speed); - int (*register_commands)(struct command_context_s *cmd_ctx); - int (*init)(void); - int (*quit)(void); - /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns - a failure if it can't support the KHz/RTCK. - - WARNING!!!! if RTCK is *slow* then think carefully about - whether you actually want to support this in the driver. - Many target scripts are written to handle the absence of RTCK - and use a fallback kHz TCK. - */ - int (*khz)(int khz, int *jtag_speed); - /* returns the KHz for the provided JTAG speed. 0=RTCK. The function returns - a failure if it can't support the KHz/RTCK. */ - int (*speed_div)(int speed, int *khz); - - /* Read and clear the power dropout flag. Note that a power dropout - can be transitionary, easily much less than a ms. - - So to find out if the power is *currently* on, you must invoke - this method twice. Once to clear the power dropout flag and a - second time to read the current state. - - Currently the default implementation is never to detect power dropout. - */ - int (*power_dropout)(int *power_dropout); - /* Read and clear the srst asserted detection flag. - * - * NB!!!! like power_dropout this does *not* read the current - * state. srst assertion is transitionary and *can* be much - * less than 1ms. - */ - int (*srst_asserted)(int *srst_asserted); - -} jtag_interface_t; - -enum jtag_event -{ - JTAG_TRST_ASSERTED +/// Attempt to configure the interface for the specified KHz. +int jtag_config_khz(unsigned khz); +/** + * Attempt to enable RTCK/RCLK. If that fails, fallback to the + * specified frequency. + */ +int jtag_config_rclk(unsigned fallback_speed_khz); +/// Retreives the clock speed of the JTAG interface in KHz. +unsigned jtag_get_speed_khz(void); + + +enum reset_types { + RESET_NONE = 0x0, + RESET_HAS_TRST = 0x1, + RESET_HAS_SRST = 0x2, + RESET_TRST_AND_SRST = 0x3, + RESET_SRST_PULLS_TRST = 0x4, + RESET_TRST_PULLS_SRST = 0x8, + RESET_TRST_OPEN_DRAIN = 0x10, + RESET_SRST_PUSH_PULL = 0x20, + RESET_SRST_NO_GATING = 0x40, }; -extern char* jtag_event_strings[]; +enum reset_types jtag_get_reset_config(void); +void jtag_set_reset_config(enum reset_types type); -extern int jtag_trst; -extern int jtag_srst; +void jtag_set_nsrst_delay(unsigned delay); +unsigned jtag_get_nsrst_delay(void); -typedef struct jtag_event_callback_s -{ - int (*callback)(enum jtag_event event, void *priv); - void *priv; - struct jtag_event_callback_s *next; -} jtag_event_callback_t; +void jtag_set_ntrst_delay(unsigned delay); +unsigned jtag_get_ntrst_delay(void); -extern jtag_event_callback_t *jtag_event_callbacks; +void jtag_set_nsrst_assert_width(unsigned delay); +unsigned jtag_get_nsrst_assert_width(void); -extern jtag_interface_t *jtag; /* global pointer to configured JTAG interface */ -extern enum tap_state end_state; -extern enum tap_state cur_state; +void jtag_set_ntrst_assert_width(unsigned delay); +unsigned jtag_get_ntrst_assert_width(void); -extern int jtag_speed; -extern int jtag_speed_post_reset; +/// @returns The current state of TRST. +int jtag_get_trst(void); +/// @returns The current state of SRST. +int jtag_get_srst(void); -enum reset_types -{ - RESET_NONE = 0x0, - RESET_HAS_TRST = 0x1, - RESET_HAS_SRST = 0x2, - RESET_TRST_AND_SRST = 0x3, - RESET_SRST_PULLS_TRST = 0x4, - RESET_TRST_PULLS_SRST = 0x8, - RESET_TRST_OPEN_DRAIN = 0x10, - RESET_SRST_PUSH_PULL = 0x20, -}; +/// Enable or disable data scan verification checking. +void jtag_set_verify(bool enable); +/// @returns True if data scan verification will be performed. +bool jtag_will_verify(void); -extern enum reset_types jtag_reset_config; +/// Enable or disable verification of IR scan checking. +void jtag_set_verify_capture_ir(bool enable); +/// @returns True if IR scan verification will be performed. +bool jtag_will_verify_capture_ir(void); -/* initialize interface upon startup. A successful no-op - * upon subsequent invocations +/** + * Initialize interface upon startup. Return a successful no-op upon + * subsequent invocations. */ -extern int jtag_interface_init(struct command_context_s *cmd_ctx); -/* initialize JTAG chain using only a TLR reset. If init fails, +extern int jtag_interface_init(struct command_context_s* cmd_ctx); + +/// Shutdown the JTAG interface upon program exit. +extern int jtag_interface_quit(void); + +/** + * Initialize JTAG chain using only a RESET reset. If init fails, * try reset + init. */ -extern int jtag_init(struct command_context_s *cmd_ctx); -/* reset, then initialize JTAG chain */ -extern int jtag_init_reset(struct command_context_s *cmd_ctx); -extern int jtag_register_commands(struct command_context_s *cmd_ctx); +extern int jtag_init(struct command_context_s* cmd_ctx); + +/// reset, then initialize JTAG chain +extern int jtag_init_reset(struct command_context_s* cmd_ctx); +extern int jtag_register_commands(struct command_context_s* cmd_ctx); +extern int jtag_init_inner(struct command_context_s *cmd_ctx); + +/** + * @file + * The JTAG interface can be implemented with a software or hardware fifo. + * + * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states; however, + * TAP_DRSHIFT/IRSHIFT can be emulated as end states, by using longer + * scans. + * + * Code that is relatively insensitive to the path taken through state + * machine (as long as it is JTAG compliant) can use @a endstate for + * jtag_add_xxx_scan(). Otherwise, the pause state must be specified as + * end state and a subsequent jtag_add_pathmove() must be issued. + */ -/* JTAG interface, can be implemented with a software or hardware fifo +/** + * Generate an IR SCAN with a list of scan fields with one entry for + * each enabled TAP. * - * TAP_SD and TAP_SI are illegal end states. TAP_SD/SI as end states - * can be emulated by using a larger scan. + * If the input field list contains an instruction value for a TAP then + * that is used otherwise the TAP is set to bypass. * - * Code that is relatively insensitive to the path(as long - * as it is JTAG compliant) taken through state machine can use - * endstate for jtag_add_xxx_scan(). Otherwise the pause state must be - * specified as end state and a subsequent jtag_add_pathmove() must - * be issued. + * TAPs for which no fields are passed are marked as bypassed for + * subsequent DR SCANs. * */ -extern void jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern void jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -/* run a TAP_TLR reset. End state is TAP_TLR, regardless - * of start state. +extern void jtag_add_ir_scan(int num_fields, scan_field_t* fields, tap_state_t endstate); +/** + * The same as jtag_add_ir_scan except no verification is performed out + * the output values. + */ +extern void jtag_add_ir_scan_noverify(int num_fields, const scan_field_t *fields, tap_state_t state); +/** + * Duplicate the scan fields passed into the function into an IR SCAN + * command. This function assumes that the caller handles extra fields + * for bypassed TAPs. + */ +extern void jtag_add_plain_ir_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate); + + +/** + * Set in_value to point to 32 bits of memory to scan into. This + * function is a way to handle the case of synchronous and asynchronous + * JTAG queues. + * + * In the event of an asynchronous queue execution the queue buffer + * allocation method is used, for the synchronous case the temporary 32 + * bits come from the input field itself. + */ +extern void jtag_alloc_in_value32(scan_field_t *field); + +/** + * Generate a DR SCAN using the fields passed to the function. + * For connected TAPs, the function checks in_fields and uses fields + * specified there. For bypassed TAPs, the function generates a dummy + * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan(). + */ +extern void jtag_add_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate); +/// A version of jtag_add_dr_scan() that uses the check_value/mask fields +extern void jtag_add_dr_scan_check(int num_fields, scan_field_t* fields, tap_state_t endstate); +/** + * Duplicate the scan fields passed into the function into a DR SCAN + * command. Unlike jtag_add_dr_scan(), this function assumes that the + * caller handles extra fields for bypassed TAPs. + */ +extern void jtag_add_plain_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate); + +/** + * Defines the type of data passed to the jtag_callback_t interface. + * The underlying type must allow storing an @c int or pointer type. + */ +typedef intptr_t jtag_callback_data_t; + +/** + * Defines a simple JTAG callback that can allow conversions on data + * scanned in from an interface. + * + * This callback should only be used for conversion that cannot fail. + * For conversion types or checks that can fail, use the more complete + * variant: jtag_callback_t. + */ +typedef void (*jtag_callback1_t)(jtag_callback_data_t data0); + +/// A simpler version of jtag_add_callback4(). +extern void jtag_add_callback(jtag_callback1_t, jtag_callback_data_t data0); + + + +/** + * Defines the interface of the JTAG callback mechanism. + * + * @param in the pointer to the data clocked in + * @param data1 An integer big enough to use as an @c int or a pointer. + * @param data2 An integer big enough to use as an @c int or a pointer. + * @param data3 An integer big enough to use as an @c int or a pointer. + * @returns an error code + */ +typedef int (*jtag_callback_t)(jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3); + + +/** + * This callback can be executed immediately the queue has been flushed. + * + * The JTAG queue can be executed synchronously or asynchronously. + * Typically for USB, the queue is executed asynchronously. For + * low-latency interfaces, the queue may be executed synchronously. + * + * The callback mechanism is very general and does not make many + * assumptions about what the callback does or what its arguments are. + * These callbacks are typically executed *after* the *entire* JTAG + * queue has been executed for e.g. USB interfaces, and they are + * guaranteeed to be invoked in the order that they were queued. + * + * If the execution of the queue fails before the callbacks, then -- + * depending on driver implementation -- the callbacks may or may not be + * invoked. @todo Can we make this behavior consistent? + * + * The strange name is due to C's lack of overloading using function + * arguments. + * + * @param f The callback function to add. + * @param data0 Typically used to point to the data to operate on. + * Frequently this will be the data clocked in during a shift operation. + * @param data1 An integer big enough to use as an @c int or a pointer. + * @param data2 An integer big enough to use as an @c int or a pointer. + * @param data3 An integer big enough to use as an @c int or a pointer. + * + */ +extern void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0, + jtag_callback_data_t data1, jtag_callback_data_t data2, + jtag_callback_data_t data3); + + +/** + * Run a TAP_RESET reset where the end state is TAP_RESET, + * regardless of the start state. */ extern void jtag_add_tlr(void); -extern int interface_jtag_add_tlr(void); -/* Do not use jtag_add_pathmove() unless you need to, but do use it + +/** + * Application code *must* assume that interfaces will + * implement transitions between states with different + * paths and path lengths through the state diagram. The + * path will vary across interface and also across versions + * of the same interface over time. Even if the OpenOCD code + * is unchanged, the actual path taken may vary over time + * and versions of interface firmware or PCB revisions. + * + * Use jtag_add_pathmove() when specific transition sequences + * are required. + * + * Do not use jtag_add_pathmove() unless you need to, but do use it * if you have to. * * DANGER! If the target is dependent upon a particular sequence @@ -324,7 +510,7 @@ extern int interface_jtag_add_tlr(void); * all drivers can support this, but it is required for e.g. * XScale and Xilinx support * - * Note! TAP_TLR must not be used in the path! + * Note! TAP_RESET must not be used in the path! * * Note that the first on the list must be reachable * via a single transition from the current state. @@ -337,19 +523,40 @@ extern int interface_jtag_add_tlr(void); * can only implement a few transitions and therefore * a partial implementation of pathmove would have little practical * application. + * + * If an error occurs, jtag_error will contain one of these error codes: + * - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable. + * - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET. + * - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid + * state transitions. */ -extern void jtag_add_pathmove(int num_states, enum tap_state *path); -extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path); -/* go to TAP_RTI, if we're not already there and cycle - * precisely num_cycles in the TAP_RTI after which move - * to the end state, if it is != TAP_RTI +extern void jtag_add_pathmove(int num_states, const tap_state_t* path); + +/** + * jtag_add_statemove() moves from the current state to @a goal_state. + * + * @param goal_state The final TAP state. + * @return ERROR_OK on success, or an error code on failure. + * + * Moves from the current state to the goal \a state. + * Both states must be stable. + */ +extern int jtag_add_statemove(tap_state_t goal_state); + +/** + * Goes to TAP_IDLE (if we're not already there), cycle + * precisely num_cycles in the TAP_IDLE state, after which move + * to @a endstate (unless it is also TAP_IDLE). * - * nb! num_cycles can be 0, in which case the fn will navigate - * to endstate via TAP_RTI + * @param num_cycles Number of cycles in TAP_IDLE state. This argument + * may be 0, in which case this routine will navigate to @a endstate + * via TAP_IDLE. + * @param endstate The final state. */ -extern void jtag_add_runtest(int num_cycles, enum tap_state endstate); -extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate); -/* A reset of the TAP state machine can be requested. +extern void jtag_add_runtest(int num_cycles, tap_state_t endstate); + +/** + * A reset of the TAP state machine can be requested. * * Whether tms or trst reset is used depends on the capabilities of * the target and jtag interface(reset_config command configures this). @@ -372,22 +579,36 @@ extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate); * then trst & srst *must* be asserted together. */ extern void jtag_add_reset(int req_tlr_or_trst, int srst); -/* this drives the actual srst and trst pins. srst will always be 0 - * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for - * trst. + + +/** + * Function jtag_set_end_state * - * the higher level jtag_add_reset will invoke jtag_add_tlr() if - * approperiate - */ -extern int interface_jtag_add_reset(int trst, int srst); -extern void jtag_add_end_state(enum tap_state endstate); -extern int interface_jtag_add_end_state(enum tap_state endstate); -extern void jtag_add_sleep(u32 us); -extern int interface_jtag_add_sleep(u32 us); + * Set a global variable to \a state if \a state != TAP_INVALID. + * + * Return the value of the global variable. + * + **/ +extern tap_state_t jtag_set_end_state(tap_state_t state); +/** + * Function jtag_get_end_state + * + * Return the value of the global variable for end state + * + **/ +extern tap_state_t jtag_get_end_state(void); +extern void jtag_add_sleep(uint32_t us); + +/** + * Function jtag_add_stable_clocks + * first checks that the state in which the clocks are to be issued is + * stable, then queues up clock_count clocks for transmission. + */ +void jtag_add_clocks(int num_cycles); -/* +/** * For software FIFO implementations, the queued commands can be executed * during this call or earlier. A sw queue might decide to push out * some of the jtag_add_xxx() operations once the queue is "big enough". @@ -397,7 +618,7 @@ extern int interface_jtag_add_sleep(u32 us); * matter if the operation was executed *before* jtag_execute_queue(), * jtag_execute_queue() will still return an error code. * - * All jtag_add_xxx() calls that have in_handler!=NULL will have been + * All jtag_add_xxx() calls that have in_handler != NULL will have been * executed when this fn returns, but if what has been queued only * clocks data out, without reading anything back, then JTAG could * be running *after* jtag_execute_queue() returns. The API does @@ -408,82 +629,110 @@ extern int interface_jtag_add_sleep(u32 us); * at some time between the jtag_add_xxx() fn call and jtag_execute_queue(). */ extern int jtag_execute_queue(void); -/* can be implemented by hw+sw */ -extern int interface_jtag_execute_queue(void); -extern int jtag_power_dropout(int *dropout); -extern int jtag_srst_asserted(int *srst_asserted); +/// same as jtag_execute_queue() but does not clear the error flag +extern void jtag_execute_queue_noclear(void); -/* JTAG support functions */ -extern void jtag_set_check_value(scan_field_t *field, u8 *value, u8 *mask, error_handler_t *in_error_handler); -extern enum scan_type jtag_scan_type(scan_command_t *cmd); -extern int jtag_scan_size(scan_command_t *cmd); -extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd); -extern int jtag_build_buffer(scan_command_t *cmd, u8 **buffer); -extern jtag_device_t* jtag_get_device(int num); -extern void jtag_sleep(u32 us); -extern int jtag_call_event_callbacks(enum jtag_event event); -extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv); +/// @returns the number of times the scan queue has been flushed +int jtag_get_flush_queue_count(void); -extern int jtag_verify_capture_ir; +/// Report Tcl event to all TAPs +void jtag_notify_event(enum jtag_event); -/* error codes - * JTAG subsystem uses codes between -100 and -199 */ -#define ERROR_JTAG_INIT_FAILED (-100) -#define ERROR_JTAG_INVALID_INTERFACE (-101) -#define ERROR_JTAG_NOT_IMPLEMENTED (-102) -#define ERROR_JTAG_TRST_ASSERTED (-103) -#define ERROR_JTAG_QUEUE_FAILED (-104) -#define ERROR_JTAG_DEVICE_ERROR (-107) +/* can be implemented by hw + sw */ +extern int jtag_power_dropout(int* dropout); +extern int jtag_srst_asserted(int* srst_asserted); + +/* JTAG support functions */ +/** + * Execute jtag queue and check value with an optional mask. + * @param field Pointer to scan field. + * @param value Pointer to scan value. + * @param mask Pointer to scan mask; may be NULL. + * @returns Nothing, but calls jtag_set_error() on any error. + */ +extern void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask); +extern void jtag_sleep(uint32_t us); -/* this allows JTAG devices to implement the entire jtag_xxx() layer in hw/sw */ -#ifdef HAVE_JTAG_MINIDRIVER_H -/* Here a #define MINIDRIVER() and an inline version of hw fifo interface_jtag_add_dr_out can be defined */ -#include "jtag_minidriver.h" -#define MINIDRIVER(a) notused ## a -#else -#define MINIDRIVER(a) a -/* jtag_add_dr_out() is a faster version of jtag_add_dr_scan() +/* + * The JTAG subsystem defines a number of error codes, + * using codes between -100 and -199. + */ +#define ERROR_JTAG_INIT_FAILED (-100) +#define ERROR_JTAG_INVALID_INTERFACE (-101) +#define ERROR_JTAG_NOT_IMPLEMENTED (-102) +#define ERROR_JTAG_TRST_ASSERTED (-103) +#define ERROR_JTAG_QUEUE_FAILED (-104) +#define ERROR_JTAG_NOT_STABLE_STATE (-105) +#define ERROR_JTAG_DEVICE_ERROR (-107) +#define ERROR_JTAG_STATE_INVALID (-108) +#define ERROR_JTAG_TRANSITION_INVALID (-109) +#define ERROR_JTAG_INIT_SOFT_FAIL (-110) + +/** + * jtag_add_dr_out() is a version of jtag_add_dr_scan() which + * only scans data out. It operates on 32 bit integers instead + * of 8 bit, which makes it a better impedance match with + * the calling code which often operate on 32 bit integers. * - * Current or end_state can not be TAP_TLR. end_state can be -1 + * Current or end_state can not be TAP_RESET. end_state can be TAP_INVALID * * num_bits[i] is the number of bits to clock out from value[i] LSB first. * * If the device is in bypass, then that is an error condition in - * the caller code that is not detected by this fn, whereas jtag_add_dr_scan() - * does detect it. Similarly if the device is not in bypass, data must - * be passed to it. + * the caller code that is not detected by this fn, whereas + * jtag_add_dr_scan() does detect it. Similarly if the device is not in + * bypass, data must be passed to it. * * If anything fails, then jtag_error will be set and jtag_execute() will * return an error. There is no way to determine if there was a failure * during this function call. * - * Note that this jtag_add_dr_out can be defined as an inline function. + * This is an inline fn to speed up embedded hosts. Also note that + * interface_jtag_add_dr_out() can be a *small* inline function for + * embedded hosts. + * + * There is no jtag_add_dr_outin() version of this fn that also allows + * clocking data back in. Patches gladly accepted! */ -extern void interface_jtag_add_dr_out(int device, - int num_fields, - const int *num_bits, - const u32 *value, - enum tap_state end_state); -#endif +extern void jtag_add_dr_out(jtag_tap_t* tap, + int num_fields, const int* num_bits, const uint32_t* value, + tap_state_t end_state); +/** + * Set the current JTAG core execution error, unless one was set + * by a previous call previously. Driver or application code must + * use jtag_error_clear to reset jtag_error once this routine has been + * called with a non-zero error code. + */ +void jtag_set_error(int error); +/// @returns The current value of jtag_error +int jtag_get_error(void); +/** + * Resets jtag_error to ERROR_OK, returning its previous value. + * @returns The previous value of @c jtag_error. + */ +int jtag_error_clear(void); +/** + * Return true if it's safe for a background polling task to access the + * JTAG scan chain. Polling may be explicitly disallowed, and is also + * unsafe while nTRST is active or the JTAG clock is gated off., + */ +bool is_jtag_poll_safe(void); -static __inline__ void jtag_add_dr_out(int device, - int num_fields, - const int *num_bits, - const u32 *value, - enum tap_state end_state) -{ - if (end_state != -1) - cmd_queue_end_state=end_state; - cmd_queue_cur_state=cmd_queue_end_state; - interface_jtag_add_dr_out(device, num_fields, num_bits, value, cmd_queue_end_state); -} +/** + * Return flag reporting whether JTAG polling is disallowed. + */ +bool jtag_poll_get_enabled(void); +/** + * Assign flag reporting whether JTAG polling is disallowed. + */ +void jtag_poll_set_enabled(bool value); #endif /* JTAG_H */