Continue encapsulation of JTAG event callback sub-API:

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

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index fd4953ec04683f17683976dc4e54b3ebdc9bae37..ce8daccc926cd63ae4bdfcc9c4d2b9a4d212f642 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -248,15 +248,35 @@ 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 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,
@@ -269,7 +289,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
@@ -569,36 +590,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);
@@ -616,12 +620,6 @@ extern int jtag_srst_asserted(int* srst_asserted);
 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;
-
-void jtag_tap_handle_event(jtag_tap_t* tap, enum jtag_tap_event e);
 
 /*
  * The JTAG subsystem defines a number of error codes,
@@ -716,4 +714,7 @@ 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 */