Make #include guard naming consistent

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

diff --git a/src/svf/svf.h b/src/svf/svf.h
index 822cad22e94eb303f9ea41e777c43801ee85800d..4101a3f853a3251ac32f5e2e6b92fc0dcec47ffb 100644 (file)
--- a/src/svf/svf.h
+++ b/src/svf/svf.h
@@ -13,15 +13,35 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef SVF_H
-#define SVF_H
 
-#include "command.h"
+#ifndef OPENOCD_SVF_SVF_H
+#define OPENOCD_SVF_SVF_H
 
-extern int svf_register_commands(struct command_context_s *cmd_ctx);
+#include <jtag/jtag.h>
 
-#endif /* SVF_H */
+int svf_register_commands(struct command_context *cmd_ctx);
+
+/**
+ * svf_add_statemove() moves from the current state to @a goal_state.
+ *
+ * @param goal_state The final TAP state.
+ * @return ERROR_OK on success, or an error code on failure.
+ *
+ * The current and goal states must satisfy svf_tap_state_is_stable().
+ * State transition paths used by this routine are those given in the
+ * SVF specification for single-argument STATE commands (and also used
+ * for various other state transitions).
+ */
+int svf_add_statemove(tap_state_t goal_state);
+
+/**
+ * svf_tap_state_is_stable() returns true for stable non-SHIFT states
+ *
+ * @param state The TAP state in question
+ * @return true iff the state is stable and not a SHIFT state.
+ */
+bool svf_tap_state_is_stable(tap_state_t state);
+
+#endif /* OPENOCD_SVF_SVF_H */