SVF: clean up, mostly for TAP state name handling

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

diff --git a/src/jtag/interface.h b/src/jtag/interface.h
index cc6ba42d4d953e101e5a97e7e44abd7f4f013e05..afe21086c0f79f238ff8f06db9b2fb400334f981 100644 (file)
--- a/src/jtag/interface.h
+++ b/src/jtag/interface.h
@@ -26,6 +26,8 @@
 #ifndef OPENOCD_JTAG_INTERFACE_H
 #define OPENOCD_JTAG_INTERFACE_H
 
+#include "jtag.h"
+
 /* @file
  * The "Cable Helper API" is what the cable drivers can use to help
  * implement their "Cable API".  So a Cable Helper API is a set of
@@ -57,7 +59,7 @@ void tap_set_state_impl(tap_state_t new_state);
 #if defined(_DEBUG_JTAG_IO_)
 #define tap_set_state(new_state) \
        do { \
-               LOG_DEBUG( "tap_set_state(%s)", tap_state_name(new_state) ); \
+               LOG_DEBUG("tap_set_state(%s)", tap_state_name(new_state)); \
                tap_set_state_impl(new_state); \
        } while (0)
 #else
@@ -158,15 +160,6 @@ bool tap_is_state_stable(tap_state_t astate);
  */
 tap_state_t tap_state_transition(tap_state_t current_state, bool tms);
 
-/**
- * Function tap_state_name
- * Returns a string suitable for display representing the JTAG tap_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);
-
 /// Allow switching between old and new TMS tables. @see tap_get_tms_path
 void tap_use_new_tms_table(bool use_new);
 /// @returns True if new TMS table is active; false otherwise.
@@ -193,49 +186,89 @@ static inline tap_state_t jtag_debug_state_machine(const void *tms_buf,
 
 typedef struct jtag_interface_s
 {
+       /// The name of the JTAG interface driver.
        char* name;
 
-       /* queued command execution
+       /**
+        * Execute queued commands.
+        * @returns ERROR_OK on success, or an error code on failure.
         */
        int (*execute_queue)(void);
 
-       /* interface initalization
+       /**
+        * Set the interface speed.
+        * @param speed The new interface speed setting.
+        * @returns ERROR_OK on success, or an error code on failure.
         */
        int (*speed)(int speed);
+
+       /**
+        * The interface driver may register additional commands to expose
+        * additional features not covered by the standard command set.
+        * @param cmd_ctx The context in which commands should be registered.
+        * @returns ERROR_OK on success, or an error code on failure.
+        */
        int (*register_commands)(struct command_context_s* cmd_ctx);
+
+       /**
+        * Interface driver must initalize any resources and connect to a
+        * JTAG device.
+        * @returns ERROR_OK on success, or an error code on failure.
+        */
        int (*init)(void);
+
+       /**
+        * Interface driver must tear down all resources and disconnect from
+        * the JTAG device.
+        * @returns ERROR_OK on success, or an error code on failure.
+        */
        int (*quit)(void);
 
-       /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
+       /**
+        * Returns JTAG maxium speed for KHz. 0 = RTCK. The function returns
         *  a failure if it can't support the KHz/RTCK.
         *
         *  WARNING!!!! if RTCK is *slow* then think carefully about
         *  whether you actually want to support this in the driver.
         *  Many target scripts are written to handle the absence of RTCK
         *  and use a fallback kHz TCK.
+        * @returns ERROR_OK on success, or an error code on failure.
         */
        int (*khz)(int khz, int* jtag_speed);
 
-       /* returns the KHz for the provided JTAG speed. 0=RTCK. The function returns
-        *  a failure if it can't support the KHz/RTCK. */
+       /**
+        * Calculate the clock frequency (in KHz) for the given @a speed.
+        * @param speed The desired interface speed setting.
+        * @param khz On return, contains the speed in KHz (0 for RTCK).
+        * @returns ERROR_OK on success, or an error code if the
+        * interface cannot support the specified speed (KHz or RTCK).
+        */
        int (*speed_div)(int speed, int* khz);
 
-       /* Read and clear the power dropout flag. Note that a power dropout
-        *  can be transitionary, easily much less than a ms.
+       /**
+        * Read and clear the power dropout flag. Note that a power dropout
+        * can be transitionary, easily much less than a ms.
         *
-        *  So to find out if the power is *currently* on, you must invoke
-        *  this method twice. Once to clear the power dropout flag and a
-        *  second time to read the current state.
+        * To find out if the power is *currently* on, one must invoke this
+        * method twice.  Once to clear the power dropout flag and a second
+        * time to read the current state.  The default implementation
+        * never reports power dropouts.
         *
-        *  Currently the default implementation is never to detect power dropout.
+        * @returns ERROR_OK on success, or an error code on failure.
         */
        int (*power_dropout)(int* power_dropout);
 
-       /* Read and clear the srst asserted detection flag.
+       /**
+        * Read and clear the srst asserted detection flag.
+        *
+        * Like power_dropout this does *not* read the current
+        * state.  SRST assertion is transitionary and may be much
+        * less than 1ms, so the interface driver must watch for these
+        * events until this routine is called.
         *
-        * NB!!!! like power_dropout this does *not* read the current
-        * state. srst assertion is transitionary and *can* be much
-        * less than 1ms.
+        * @param srst_asserted On return, indicates whether SRST has
+        * been asserted.
+        * @returns ERROR_OK on success, or an error code on failure.
         */
        int (*srst_asserted)(int* srst_asserted);
 } jtag_interface_t;