/// The current TAP state of the pending JTAG command queue.
extern tap_state_t cmd_queue_cur_state;
-/// The TAP state in which DR scans should end.
-extern tap_state_t cmd_queue_end_state;
/**
* This structure defines a single scan field in the scan. It provides
u8 intmp[4];
} scan_field_t;
-#ifdef INCLUDE_JTAG_INTERFACE_H
-
-/**
- * The inferred type of a scan_command_s structure, indicating whether
- * the command has the host scan in from the device, the host scan out
- * to the device, or both.
- */
-enum scan_type {
- /// From device to host,
- SCAN_IN = 1,
- /// From host to device,
- SCAN_OUT = 2,
- /// Full-duplex scan.
- SCAN_IO = 3
-};
-
-/**
- * The scan_command provide a means of encapsulating a set of scan_field_s
- * structures that should be scanned in/out to the device.
- */
-typedef struct scan_command_s
-{
- /// instruction/not data scan
- bool ir_scan;
- /// number of fields in *fields array
- int num_fields;
- /// pointer to an array of data scan fields
- scan_field_t* fields;
- /// state in which JTAG commands should finish
- tap_state_t end_state;
-} scan_command_t;
-
-typedef struct statemove_command_s
-{
- /// state in which JTAG commands should finish
- tap_state_t end_state;
-} statemove_command_t;
-
-typedef struct pathmove_command_s
-{
- /// number of states in *path
- int num_states;
- /// states that have to be passed
- tap_state_t* path;
-} pathmove_command_t;
-
-typedef struct runtest_command_s
-{
- /// number of cycles to spend in Run-Test/Idle state
- int num_cycles;
- /// state in which JTAG commands should finish
- tap_state_t end_state;
-} runtest_command_t;
-
-
-typedef struct stableclocks_command_s
-{
- /// number of clock cycles that should be sent
- int num_cycles;
-} stableclocks_command_t;
-
-
-typedef struct reset_command_s
-{
- /// Set TRST output: 0=deassert, 1=assert, -1=no change
- int trst;
- /// Set SRST output: 0=deassert, 1=assert, -1=no change
- int srst;
-} reset_command_t;
-
-typedef struct end_state_command_s
-{
- /// state in which JTAG commands should finish
- tap_state_t end_state;
-} end_state_command_t;
-
-typedef struct sleep_command_s
-{
- /// number of microseconds to sleep
- u32 us;
-} sleep_command_t;
-
-/**
- * Defines a container type that hold a pointer to a JTAG command
- * structure of any defined type.
- */
-typedef union jtag_command_container_u
-{
- scan_command_t* scan;
- statemove_command_t* statemove;
- pathmove_command_t* pathmove;
- runtest_command_t* runtest;
- stableclocks_command_t* stableclocks;
- reset_command_t* reset;
- end_state_command_t* end_state;
- sleep_command_t* sleep;
-} jtag_command_container_t;
-
-/**
- * The type of the @c jtag_command_container_u contained by a
- * @c jtag_command_s structure.
- */
-enum jtag_command_type {
- JTAG_SCAN = 1,
- JTAG_STATEMOVE = 2,
- JTAG_RUNTEST = 3,
- JTAG_RESET = 4,
- JTAG_PATHMOVE = 6,
- JTAG_SLEEP = 7,
- JTAG_STABLECLOCKS = 8
-};
-
-typedef struct jtag_command_s
-{
- jtag_command_container_t cmd;
- enum jtag_command_type type;
- struct jtag_command_s* next;
-} jtag_command_t;
-
-/// The current queue of jtag_command_s structures.
-extern jtag_command_t* jtag_command_queue;
-
-extern void* cmd_queue_alloc(size_t size);
-extern void cmd_queue_free(void);
-
-extern void jtag_queue_command(jtag_command_t *cmd);
-extern void jtag_command_queue_reset(void);
-
-#endif // INCLUDE_JTAG_INTERFACE_H
-
typedef struct jtag_tap_event_action_s jtag_tap_event_action_t;
/* this is really: typedef jtag_tap_t */
jtag_tap_t* next_tap;
};
-extern jtag_tap_t* jtag_AllTaps(void);
-extern jtag_tap_t* jtag_TapByPosition(int n);
-extern jtag_tap_t* jtag_TapByString(const char* dotted_name);
-extern jtag_tap_t* jtag_TapByJimObj(Jim_Interp* interp, Jim_Obj* obj);
-extern jtag_tap_t* jtag_TapByAbsPosition(int abs_position);
-extern int jtag_NumEnabledTaps(void);
-extern int jtag_NumTotalTaps(void);
-
-static __inline__ jtag_tap_t* jtag_NextEnabledTap(jtag_tap_t* p)
+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 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_AllTaps();
+ p = jtag_all_taps();
}
else
{
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
+ *
+ **/
enum jtag_event {
JTAG_TRST_ASSERTED
};
-extern char* jtag_event_strings[];
-
enum jtag_tap_event {
JTAG_TAP_EVENT_ENABLE,
JTAG_TAP_EVENT_DISABLE
};
-extern const Jim_Nvp nvp_jtag_tap_event[];
-
struct jtag_tap_event_action_s
{
enum jtag_tap_event event;
jtag_tap_event_action_t* next;
};
-extern int jtag_trst;
-extern int jtag_srst;
+/// @returns The current state of TRST.
+int jtag_get_trst(void);
+/// @returns The current state of SRST.
+int jtag_get_srst(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;
+/**
+ * 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);
+
+extern int jtag_call_event_callbacks(enum jtag_event event);
-extern jtag_event_callback_t* jtag_event_callbacks;
-extern int jtag_speed;
-extern int jtag_speed_post_reset;
+/// @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_set_speed(int speed);
enum reset_types {
RESET_NONE = 0x0,
RESET_SRST_PUSH_PULL = 0x20,
};
-extern enum reset_types jtag_reset_config;
+enum reset_types jtag_get_reset_config(void);
+void jtag_set_reset_config(enum reset_types type);
/**
* Initialize interface upon startup. Return a successful no-op upon
* end state and a subsequent jtag_add_pathmove() must be issued.
*/
+/**
+ * Generate an IR SCAN with a list of scan fields with one entry for
+ * each enabled TAP.
+ *
+ * If the input field list contains an instruction value for a TAP then
+ * that is used otherwise the TAP is set to bypass.
+ *
+ * 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, 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);
/**
*/
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);
-extern void jtag_add_plain_ir_scan(int num_fields, const 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);
* 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, const tap_state_t* path);
*/
extern void jtag_add_reset(int req_tlr_or_trst, int srst);
-extern void jtag_add_end_state(tap_state_t endstate);
+
+/**
+ * Function jtag_set_end_state
+ *
+ * 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(u32 us);
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().
+ * 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_error;
-
-static __inline__ void jtag_set_error(int error)
-{
- if ((error==ERROR_OK)||(jtag_error!=ERROR_OK))
- {
- /* keep first error */
- return;
- }
- jtag_error=error;
-}
-
-
+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);
/* can be implemented by hw+sw */
extern int jtag_power_dropout(int* dropout);
*/
extern void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask);
-#ifdef INCLUDE_JTAG_INTERFACE_H
-extern enum scan_type jtag_scan_type(const scan_command_t* cmd);
-extern int jtag_scan_size(const scan_command_t* cmd);
-extern int jtag_read_buffer(u8* buffer, const scan_command_t* cmd);
-extern int jtag_build_buffer(const scan_command_t* cmd, u8** buffer);
-#endif // INCLUDE_JTAG_INTERFACE_H
-
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;
-
-void jtag_tap_handle_event(jtag_tap_t* tap, enum jtag_tap_event e);
/*
* The JTAG subsystem defines a number of error codes,
#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)
/**
* jtag_add_dr_out() is a version of jtag_add_dr_scan() which
/**
* jtag_add_statemove() moves from the current state to @a goal_state.
*
- * This function was originally designed to handle the XSTATE command
- * from the XSVF specification.
- *
* @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.
*/
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_ntrst_delay(unsigned delay);
+unsigned jtag_get_ntrst_delay(void);
+
+int jtag_config_khz(unsigned khz);
+void jtag_set_speed_khz(unsigned speed);
+unsigned jtag_get_speed_khz(void);
+
+void jtag_set_verify(bool enable);
+bool jtag_will_verify(void);
+
+void jtag_set_verify_capture_ir(bool enable);
+bool jtag_will_verify_capture_ir(void);
+
#endif /* JTAG_H */
Code Review / openocd.git / blobdiff