* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
-* Copyright (C) 2007,2008 Øyvind Harboe *
+* Copyright (C) 2007,2008 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* This program is free software; you can redistribute it and/or modify *
#ifdef _DEBUG_JTAG_IO_
-#define DEBUG_JTAG_IO(expr ...) LOG_DEBUG(expr)
+#define DEBUG_JTAG_IO(expr ...) \
+ do { if (1) LOG_DEBUG(expr); } while (0)
#else
-#define DEBUG_JTAG_IO(expr ...)
+#define DEBUG_JTAG_IO(expr ...) \
+ do { if (0) LOG_DEBUG(expr); } while (0)
#endif
#ifndef DEBUG_JTAG_IOZ
*/
typedef enum tap_state
{
-#if BUILD_ECOSBOARD
+#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,
* Function tap_state_name
* Returns a string suitable for display representing the JTAG tap_state
*/
-const char* tap_state_name(tap_state_t state);
+const char *tap_state_name(tap_state_t state);
+
+/// 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.
extern tap_state_t cmd_queue_cur_state;
/// The number of bits this field specifies (up to 32)
int num_bits;
/// A pointer to value to be scanned into the device
- u8* out_value;
+ uint8_t* out_value;
/// A pointer to a 32-bit memory location for data scanned out
- u8* in_value;
+ uint8_t* in_value;
/// The value used to check the data scanned out.
- u8* check_value;
+ uint8_t* check_value;
/// The mask to go with check_value
- u8* check_mask;
+ 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
- u8 intmp[4];
+ uint8_t intmp[4];
} scan_field_t;
typedef struct jtag_tap_event_action_s jtag_tap_event_action_t;
/* this is really: typedef jtag_tap_t */
/* But - the typedef is done in "types.h" */
-/* due to "forward decloration reasons" */
+/* due to "forward declaration reasons" */
struct jtag_tap_s
{
const char* chip;
const char* tapname;
const char* dotted_name;
int abs_chain_position;
- /// Is this TAP enabled?
- int enabled;
+ /// 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 */
- u32 ir_capture_value;
- u8* expected; /**< Capture-IR expected value */
- u32 ir_capture_mask;
- u8* expected_mask; /**< Capture-IR expected mask */
- u32 idcode;
+ 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 */
- u32* expected_ids;
+ uint32_t* expected_ids;
/// Number of expected identification codes
- u8 expected_ids_cnt;
+ uint8_t expected_ids_cnt;
/// current instruction
- u8* cur_instr;
+ uint8_t* cur_instr;
/// Bypass register selected
int bypass;
jtag_tap_t* next_tap;
};
+
+void jtag_tap_init(jtag_tap_t *tap);
+void jtag_tap_free(jtag_tap_t *tap);
+
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_by_position(unsigned abs_position);
+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);
-static __inline__ jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p)
-{
- if (p == NULL)
- {
- /* start at the head of list */
- p = jtag_all_taps();
- }
- else
- {
- /* start *after* this one */
- p = p->next_tap;
- }
- while (p)
- {
- if (p->enabled)
- {
- break;
- }
- else
- {
- p = p->next_tap;
- }
- }
-
- return p;
-}
-
-
-enum reset_line_mode {
- LINE_OPEN_DRAIN = 0x0,
- LINE_PUSH_PULL = 0x1,
-};
-/*
- * There are three cases when JTAG_TRST_ASSERTED callback is invoked. The
- * event is invoked *after* TRST is asserted(or queued rather). It is illegal
- * to communicate with the JTAG interface during the callback(as there is
- * currently a queue being built).
- *
- * - TMS reset
- * - SRST pulls TRST
- * - TRST asserted
- *
- **/
+/*
+ * - 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
-};
-
-enum jtag_tap_event {
+ JTAG_TRST_ASSERTED,
+ JTAG_TAP_EVENT_SETUP,
JTAG_TAP_EVENT_ENABLE,
- JTAG_TAP_EVENT_DISABLE
+ JTAG_TAP_EVENT_DISABLE,
};
struct jtag_tap_event_action_s
{
- enum jtag_tap_event event;
+ enum jtag_event event;
Jim_Obj* body;
jtag_tap_event_action_t* next;
};
-/// @returns The current state of TRST.
-int jtag_get_trst(void);
-/// @returns The current state of SRST.
-int jtag_get_srst(void);
+/**
+ * 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);
+
+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);
+
+extern int jtag_call_event_callbacks(enum jtag_event event);
-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;
/// @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.
* @returns ERROR_OK during configuration or on success, or an error
* code returned from the interface @c speed callback.
*/
-int jtag_set_speed(int speed);
+int jtag_config_speed(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_TRST_PULLS_SRST = 0x8,
RESET_TRST_OPEN_DRAIN = 0x10,
RESET_SRST_PUSH_PULL = 0x20,
+ RESET_SRST_NO_GATING = 0x40,
};
enum reset_types jtag_get_reset_config(void);
void jtag_set_reset_config(enum reset_types type);
+void jtag_set_nsrst_delay(unsigned delay);
+unsigned jtag_get_nsrst_delay(void);
+
+void jtag_set_ntrst_delay(unsigned delay);
+unsigned jtag_get_ntrst_delay(void);
+
+void jtag_set_nsrst_assert_width(unsigned delay);
+unsigned jtag_get_nsrst_assert_width(void);
+
+void jtag_set_ntrst_assert_width(unsigned delay);
+unsigned jtag_get_ntrst_assert_width(void);
+
+/// @returns The current state of TRST.
+int jtag_get_trst(void);
+/// @returns The current state of SRST.
+int jtag_get_srst(void);
+
+/// 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);
+
+/// 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. Return a successful no-op upon
* subsequent invocations.
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_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
*/
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
* For conversion types or checks that can fail, use the more complete
* variant: jtag_callback_t.
*/
-typedef void (*jtag_callback1_t)(u8 *in);
+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, u8 *in);
+extern void jtag_add_callback(jtag_callback1_t, jtag_callback_data_t data0);
-/**
- * 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 the interface of the JTAG callback mechanism.
* @param data3 An integer big enough to use as an @c int or a pointer.
* @returns an error code
*/
-typedef int (*jtag_callback_t)(u8 *in, 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);
/**
* arguments.
*
* @param f The callback function to add.
- * @param in Typically used to point to the data to operate on.
+ * @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, u8 *in,
+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);
*/
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
*
**/
extern tap_state_t jtag_get_end_state(void);
-extern void jtag_add_sleep(u32 us);
+extern void jtag_add_sleep(uint32_t 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
*/
extern 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
extern void jtag_execute_queue_noclear(void);
-/**
- * The jtag_error variable is set when an error occurs while executing
- * the queue.
- *
- * This flag can also be set from application code, if an error happens
- * during processing that should be reported during jtag_execute_queue().
- *
- * It is cleared by jtag_execute_queue().
- */
-extern int jtag_error;
+/// @returns the number of times the scan queue has been flushed
+int jtag_get_flush_queue_count(void);
-static __inline__ void jtag_set_error(int error)
-{
- if ((error==ERROR_OK)||(jtag_error!=ERROR_OK))
- {
- /* keep first error */
- return;
- }
- jtag_error=error;
-}
+/// Report Tcl event to all TAPs
+void jtag_notify_event(enum jtag_event);
-/**
- * Resets jtag_error to ERROR_OK, returning its previous value.
- * @returns The previous value of @c jtag_error.
- */
-static inline int jtag_error_clear(void)
-{
- int temp = jtag_error;
- jtag_error = ERROR_OK;
- return temp;
-}
-/* can be implemented by hw+sw */
+/* can be implemented by hw + sw */
extern int jtag_power_dropout(int* dropout);
extern int jtag_srst_asserted(int* srst_asserted);
* @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, u8 *value, u8 *mask);
-
-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);
-
-extern int jtag_verify_capture_ir;
+extern void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask);
-void jtag_tap_handle_event(jtag_tap_t* tap, enum jtag_tap_event e);
+extern void jtag_sleep(uint32_t us);
/*
* The JTAG subsystem defines a number of error codes,
#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
* clocking data back in. Patches gladly accepted!
*/
extern void jtag_add_dr_out(jtag_tap_t* tap,
- int num_fields, const int* num_bits, const u32* value,
+ int num_fields, const int* num_bits, const uint32_t* value,
tap_state_t end_state);
/**
- * 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.
- *
- * This needs to be handled according to the xsvf spec, see the XSTATE
- * command description. From the XSVF spec, pertaining to XSTATE:
- *
- * For special states known as stable states (Test-Logic-Reset,
- * Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
- * predefined TAP state paths when the starting state is a stable state
- * and when the XSTATE specifies a new stable state. See the STATE
- * command in the [Ref 5] for the TAP state paths between stable
- * states.
- *
- * For non-stable states, XSTATE should specify a state that is only one
- * TAP state transition distance from the current TAP state to avoid
- * undefined TAP state paths. A sequence of multiple XSTATE commands can
- * be issued to transition the TAP through a specific state path.
- *
- * @note Unless @c tms_bits holds a path that agrees with [Ref 5] in the
- * above spec, then this code is not fully conformant to the xsvf spec.
- * This puts a burden on tap_get_tms_path() function from the xsvf spec.
- * If in doubt, you should confirm that that burden is being met.
- *
- * Otherwise, @a goal_state must be immediately reachable in one clock
- * cycle, and does not need to be a stable 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.
*/
-extern int jtag_add_statemove(tap_state_t goal_state);
-
-/// @returns the number of times the scan queue has been flushed
-int jtag_get_flush_queue_count(void);
-
-void jtag_set_nsrst_delay(unsigned delay);
-unsigned jtag_get_nsrst_delay(void);
+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);
-void jtag_set_ntrst_delay(unsigned delay);
-unsigned jtag_get_ntrst_delay(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);
-void jtag_set_speed_khz(unsigned speed);
-unsigned jtag_get_speed_khz(void);
+/**
+ * Return flag reporting whether JTAG polling is disallowed.
+ */
+bool jtag_poll_get_enabled(void);
-void jtag_set_verify(bool enable);
-bool jtag_will_verify(void);
+/**
+ * Assign flag reporting whether JTAG polling is disallowed.
+ */
+void jtag_poll_set_enabled(bool value);
#endif /* JTAG_H */
Code Review / openocd.git / blobdiff