David Brownell <david-b@pacbell.net>:

[openocd.git] / src / jtag / jtag.h

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index 317566ce064ac60dbdb48e57da0e67b2fa0b08de..956343eea4a6099c85fa2180532f3dcee344b2a2 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -151,8 +151,10 @@ struct jtag_tap_s
        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 */
@@ -175,6 +177,10 @@ struct jtag_tap_s
 
        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);
@@ -185,21 +191,16 @@ extern unsigned jtag_tap_count_enabled(void);
 extern unsigned jtag_tap_count(void);
 
 
-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 
+ * 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
@@ -217,11 +218,6 @@ struct jtag_tap_event_action_s
        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()
@@ -236,7 +232,7 @@ int jtag_get_srst(void);
 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_unregister_event_callback(jtag_event_handler_t f, void *x);
 
 extern int jtag_call_event_callbacks(enum jtag_event event);
 
@@ -245,7 +241,7 @@ extern int jtag_call_event_callbacks(enum jtag_event event);
 int jtag_get_speed(void);
 /**
  * Given a @a speed setting, use the interface @c speed_div callback to
- * adjust the setting.  
+ * 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.
@@ -260,6 +256,15 @@ int jtag_get_speed_readable(int *speed);
  */
 int jtag_set_speed(int speed);
 
+
+/// Attempt to configure the interface for the specified KHz.
+int jtag_config_khz(unsigned khz);
+/// Set the clock speed of the JTAG interface in KHz.
+void jtag_set_speed_khz(unsigned speed);
+/// 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,
@@ -274,6 +279,27 @@ enum reset_types {
 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);
+
+/// @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.
@@ -487,7 +513,7 @@ extern void jtag_add_pathmove(int num_states, const tap_state_t* path);
  * @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. 
+ * 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:
@@ -601,9 +627,13 @@ void jtag_add_clocks(int num_cycles);
  */
 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);
 
+/// @returns the number of times the scan queue has been flushed
+int jtag_get_flush_queue_count(void);
+
+
 /* can be implemented by hw+sw */
 extern int jtag_power_dropout(int* dropout);
 extern int jtag_srst_asserted(int* srst_asserted);
@@ -666,25 +696,6 @@ extern void jtag_add_dr_out(jtag_tap_t* tap,
                tap_state_t end_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);
-
 /**
  * Set the current JTAG core execution error, unless one was set
  * by a previous call previously.  Driver or application code must