* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
-* Copyright (C) 2007,2008 Øyvind Harboe *
+* Copyright (C) 2007-2010 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* This program is free software; you can redistribute it and/or modify *
* 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. *
+* along with this program. If not, see <http://www.gnu.org/licenses/>. *
***************************************************************************/
-#ifndef JTAG_H
-#define JTAG_H
-
-#include "binarybuffer.h"
-#include "log.h"
-
-#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
+
+#ifndef OPENOCD_JTAG_JTAG_H
+#define OPENOCD_JTAG_JTAG_H
+
+#include <helper/binarybuffer.h>
+#include <helper/log.h>
+#include <helper/replacements.h>
#ifndef DEBUG_JTAG_IOZ
#define DEBUG_JTAG_IOZ 64
#endif
-/*-----<Macros>--------------------------------------------------*/
-
-/**
- * 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]))
-
-/** Calculate the number of bytes required to hold @a n TAP scan bits */
-#define TAP_SCAN_BYTES(n) DIV_ROUND_UP(n, 8)
-
/*-----</Macros>-------------------------------------------------*/
/**
* Fix those drivers to map as appropriate ... then pick some
* sane set of numbers here (where 0/uninitialized == INVALID).
*/
-typedef enum tap_state
-{
+typedef enum tap_state {
TAP_INVALID = -1,
-#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,
-
-#else
/* Proper ARM recommended numbers */
TAP_DREXIT2 = 0x0,
TAP_DREXIT1 = 0x1,
TAP_IRUPDATE = 0xd,
TAP_IRCAPTURE = 0xe,
TAP_RESET = 0x0f,
-
-#endif
} tap_state_t;
+/**
+ * Defines arguments for reset functions
+ */
+#define SRST_DEASSERT 0
+#define SRST_ASSERT 1
+#define TRST_DEASSERT 0
+#define TRST_ASSERT 1
+
/**
* Function tap_state_name
* Returns a string suitable for display representing the JTAG tap_state
*/
const char *tap_state_name(tap_state_t state);
-/// Provides user-friendly name lookup of TAP states.
+/** Provides user-friendly name lookup of TAP states. */
tap_state_t tap_state_by_name(const char *name);
-/// The current TAP state of the pending JTAG command queue.
+/** The current TAP state of the pending JTAG command queue. */
extern tap_state_t cmd_queue_cur_state;
/**
*
* 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.
*/
struct scan_field {
- /// A pointer to the tap structure to which this field refers.
- struct jtag_tap* tap;
-
- /// The number of bits this field specifies (up to 32)
+ /** The number of bits this field specifies */
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];
+ /** A pointer to value to be scanned into the device */
+ const 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;
};
struct jtag_tap {
- const char* chip;
- const char* tapname;
- const char* dotted_name;
+ char *chip;
+ char *tapname;
+ char *dotted_name;
int abs_chain_position;
- /// Is this TAP disabled after JTAG reset?
+ /** Is this TAP disabled after JTAG reset? */
bool disabled_after_reset;
- /// Is this TAP currently enabled?
+ /** 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 */
+ uint8_t *expected; /**< Capture-IR expected value */
uint32_t ir_capture_mask;
- uint8_t* expected_mask; /**< Capture-IR expected mask */
+ uint8_t *expected_mask; /**< Capture-IR expected mask */
uint32_t idcode; /**< device identification code */
/** not all devices have idcode,
* we'll discover this during chain examination */
bool hasidcode;
- /// Array of expected identification codes */
- uint32_t* expected_ids;
- /// Number of expected identification codes
+ /** 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
+ /** Flag saying whether to ignore version field in expected_ids[] */
+ bool ignore_version;
+
+ /** Flag saying whether to ignore the bypass bit in the code */
+ bool ignore_bypass;
+
+ /** current instruction */
+ uint8_t *cur_instr;
+ /** Bypass register selected */
int bypass;
struct jtag_tap_event_action *event_action;
- struct jtag_tap* next_tap;
+ struct jtag_tap *next_tap;
+ /* private pointer to support none-jtag specific functions */
+ void *priv;
};
void jtag_tap_init(struct jtag_tap *tap);
void jtag_tap_free(struct jtag_tap *tap);
-struct jtag_tap* jtag_all_taps(void);
+struct jtag_tap *jtag_all_taps(void);
const char *jtag_tap_name(const struct jtag_tap *tap);
-struct jtag_tap* jtag_tap_by_string(const char* dotted_name);
-struct jtag_tap* jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj* obj);
-struct jtag_tap* jtag_tap_next_enabled(struct jtag_tap* p);
+struct jtag_tap *jtag_tap_by_string(const char *dotted_name);
+struct jtag_tap *jtag_tap_by_jim_obj(Jim_Interp *interp, Jim_Obj *obj);
+struct jtag_tap *jtag_tap_by_position(unsigned abs_position);
+struct jtag_tap *jtag_tap_next_enabled(struct jtag_tap *p);
unsigned jtag_tap_count_enabled(void);
unsigned jtag_tap_count(void);
-
/*
* - TRST_ASSERTED triggers two sets of callbacks, after operations to
* reset the scan chain -- via TMS+TCK signaling, or deasserting the
JTAG_TAP_EVENT_DISABLE,
};
-struct jtag_tap_event_action
-{
- enum jtag_event event;
- Jim_Obj* body;
- struct jtag_tap_event_action* next;
+struct jtag_tap_event_action {
+ /** The event for which this action will be triggered. */
+ enum jtag_event event;
+ /** The interpreter to use for evaluating the @c body. */
+ Jim_Interp *interp;
+ /** Contains a script to 'eval' when the @c event is triggered. */
+ Jim_Obj *body;
+ /* next action in linked list */
+ struct jtag_tap_event_action *next;
};
/**
- * Defines the function signature requide for JTAG event callback
+ * Defines the function signature required 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
+ * @param priv 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 int (*jtag_event_handler_t)(enum jtag_event event, void *priv);
int jtag_register_event_callback(jtag_event_handler_t f, void *x);
int jtag_unregister_event_callback(jtag_event_handler_t f, void *x);
int jtag_call_event_callbacks(enum jtag_event event);
-
-/// @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);
-
-/// 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_TRST_OPEN_DRAIN = 0x10,
RESET_SRST_PUSH_PULL = 0x20,
RESET_SRST_NO_GATING = 0x40,
+ RESET_CNCT_UNDER_SRST = 0x80
};
enum reset_types jtag_get_reset_config(void);
void jtag_set_ntrst_assert_width(unsigned delay);
unsigned jtag_get_ntrst_assert_width(void);
-/// @returns The current state of TRST.
+/** @returns The current state of TRST. */
int jtag_get_trst(void);
-/// @returns The current state of SRST.
+/** @returns The current state of SRST. */
int jtag_get_srst(void);
-/// Enable or disable data scan verification checking.
+/** Enable or disable data scan verification checking. */
void jtag_set_verify(bool enable);
-/// @returns True if data scan verification will be performed.
+/** @returns True if data scan verification will be performed. */
bool jtag_will_verify(void);
-/// Enable or disable verification of IR scan checking.
+/** 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.
+/** @returns True if IR scan verification will be performed. */
bool jtag_will_verify_capture_ir(void);
-/**
- * Initialize interface upon startup. Return a successful no-op upon
- * subsequent invocations.
- */
-int jtag_interface_init(struct command_context* cmd_ctx);
-
-/// Shutdown the JTAG interface upon program exit.
-int jtag_interface_quit(void);
+/** Set ms to sleep after jtag_execute_queue() flushes queue. Debug purposes. */
+void jtag_set_flush_queue_sleep(int ms);
/**
* Initialize JTAG chain using only a RESET reset. If init fails,
* try reset + init.
*/
-int jtag_init(struct command_context* cmd_ctx);
+int jtag_init(struct command_context *cmd_ctx);
-/// reset, then initialize JTAG chain
-int jtag_init_reset(struct command_context* cmd_ctx);
-int jtag_register_commands(struct command_context* cmd_ctx);
+/** reset, then initialize JTAG chain */
+int jtag_init_reset(struct command_context *cmd_ctx);
+int jtag_register_commands(struct command_context *cmd_ctx);
int jtag_init_inner(struct command_context *cmd_ctx);
/**
* subsequent DR SCANs.
*
*/
-void jtag_add_ir_scan(int num_fields,
- struct scan_field* fields, tap_state_t endstate);
+void jtag_add_ir_scan(struct jtag_tap *tap,
+ struct scan_field *fields, tap_state_t endstate);
/**
* The same as jtag_add_ir_scan except no verification is performed out
* the output values.
*/
-void jtag_add_ir_scan_noverify(int num_fields,
+void jtag_add_ir_scan_noverify(struct jtag_tap *tap,
const struct scan_field *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.
- */
-void jtag_add_plain_ir_scan(int num_fields,
- const struct scan_field* 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.
+ * Scan out the bits in ir scan mode.
*
- * 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.
+ * If in_bits == NULL, discard incoming bits.
*/
-void jtag_alloc_in_value32(struct scan_field *field);
+void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
+ tap_state_t endstate);
/**
* Generate a DR SCAN using the fields passed to the function.
* 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().
*/
-void jtag_add_dr_scan(int num_fields,
- const struct scan_field* fields, tap_state_t endstate);
-/// A version of jtag_add_dr_scan() that uses the check_value/mask fields
-void jtag_add_dr_scan_check(int num_fields,
- struct scan_field* fields, tap_state_t endstate);
+void jtag_add_dr_scan(struct jtag_tap *tap, int num_fields,
+ const struct scan_field *fields, tap_state_t endstate);
+/** A version of jtag_add_dr_scan() that uses the check_value/mask fields */
+void jtag_add_dr_scan_check(struct jtag_tap *tap, int num_fields,
+ struct scan_field *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.
+ * Scan out the bits in ir scan mode.
+ *
+ * If in_bits == NULL, discard incoming bits.
*/
-void jtag_add_plain_dr_scan(int num_fields,
- const struct scan_field* fields, tap_state_t endstate);
+void jtag_add_plain_dr_scan(int num_bits,
+ const uint8_t *out_bits, uint8_t *in_bits, tap_state_t endstate);
/**
* Defines the type of data passed to the jtag_callback_t interface.
*/
typedef void (*jtag_callback1_t)(jtag_callback_data_t data0);
-/// A simpler version of jtag_add_callback4().
-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);
+/** A simpler version of jtag_add_callback4(). */
+void jtag_add_callback(jtag_callback1_t f, jtag_callback_data_t data0);
/**
- * This callback can be executed immediately the queue has been flushed.
+ * Defines the interface of the JTAG callback mechanism. Such
+ * callbacks can be executed once the queue has been flushed.
*
* The JTAG queue can be executed synchronously or asynchronously.
* Typically for USB, the queue is executed asynchronously. For
* 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.
+ * guaranteed 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?
+ * invoked.
*
- * The strange name is due to C's lack of overloading using function
- * arguments.
+ * @todo Make that behavior consistent.
*
- * @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.
- *
+ * @returns an error code
*/
-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);
-
+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);
/**
* Run a TAP_RESET reset where the end state is TAP_RESET,
* path when transitioning to/from end
* state.
*
- * A list of unambigious single clock state transitions, not
+ * A list of unambiguous single clock state transitions, not
* all drivers can support this, but it is required for e.g.
* XScale and Xilinx support
*
* - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
* state transitions.
*/
-void jtag_add_pathmove(int num_states, const tap_state_t* path);
+void jtag_add_pathmove(int num_states, const tap_state_t *path);
/**
* jtag_add_statemove() moves from the current state to @a goal_state.
* to @a endstate (unless it is also TAP_IDLE).
*
* @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.
+ * may be 0, in which case this routine will navigate to @a endstate
+ * via TAP_IDLE.
* @param endstate The final state.
*/
void jtag_add_runtest(int num_cycles, tap_state_t endstate);
*/
void jtag_add_reset(int req_tlr_or_trst, int srst);
-
-/**
- * Function jtag_set_end_state
- *
- * Set a global variable to \a state if \a state != TAP_INVALID.
- *
- * Return the value of the global variable.
- *
- **/
-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
- *
- **/
-tap_state_t jtag_get_end_state(void);
void jtag_add_sleep(uint32_t us);
+int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state t);
/**
- * Function jtag_add_stable_clocks
+ * Function jtag_add_clocks
* first checks that the state in which the clocks are to be issued is
- * stable, then queues up clock_count clocks for transmission.
+ * stable, then queues up num_cycles 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
*/
int jtag_execute_queue(void);
-/// same as jtag_execute_queue() but does not clear the error flag
+/** same as jtag_execute_queue() but does not clear the error flag */
void jtag_execute_queue_noclear(void);
-/// @returns the number of times the scan queue has been flushed
+/** @returns the number of times the scan queue has been flushed */
int jtag_get_flush_queue_count(void);
-/// Report Tcl event to all TAPs
+/** Report Tcl event to all TAPs */
void jtag_notify_event(enum jtag_event);
-
/* can be implemented by hw + sw */
-int jtag_power_dropout(int* dropout);
-int jtag_srst_asserted(int* srst_asserted);
+int jtag_power_dropout(int *dropout);
+int jtag_srst_asserted(int *srst_asserted);
/* JTAG support functions */
* @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.
+ *
+ * returns Nothing, but calls jtag_set_error() on any error.
*/
void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask);
#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_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.
- *
- * 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.
- *
- * 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!
- */
-void jtag_add_dr_out(struct jtag_tap* 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
* 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.
/**
* 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.,
+ * unsafe while nTRST is active or the JTAG clock is gated off.
*/
bool is_jtag_poll_safe(void);
*/
void jtag_poll_set_enabled(bool value);
-#endif /* JTAG_H */
+#include <jtag/minidriver.h>
+
+int jim_jtag_newtap(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
+
+#endif /* OPENOCD_JTAG_JTAG_H */
projects / fw / openocd / blobdiff