Move the jtag_error helper routines out of header file:

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

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index e9caf9840876381c69a0a7eca2e22a5880a1e10d..d7698ac7589734cd09c14d3ca4b51d2626aca1d5 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -231,15 +231,11 @@ 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;
@@ -247,8 +243,10 @@ struct jtag_tap_event_action_s
        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
 {
@@ -257,10 +255,16 @@ typedef struct jtag_event_callback_s
        struct jtag_event_callback_s* next;
 } jtag_event_callback_t;
 
-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);
+/**
+ * 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,
@@ -273,7 +277,8 @@ enum reset_types {
        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
@@ -573,36 +578,19 @@ extern int jtag_execute_queue(void);
 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.
  */
-static inline int jtag_error_clear(void)
-{
-       int temp = jtag_error;
-       jtag_error = ERROR_OK;
-       return temp;
-}
+int jtag_error_clear(void);
 
 /* can be implemented by hw+sw */
 extern int jtag_power_dropout(int* dropout);
@@ -675,16 +663,36 @@ extern void jtag_add_dr_out(jtag_tap_t* tap,
 /**
  * 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);