src/svf/svf.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Simon Qian                                      *
   3  *   SimonQian@SimonQian.com                                               *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  17  ***************************************************************************/
  18
  19 #ifndef SVF_H
  20 #define SVF_H
  21
  22 #include <jtag/jtag.h>
  23
  24 int svf_register_commands(struct command_context *cmd_ctx);
  25
  26 /**
  27  * svf_add_statemove() moves from the current state to @a goal_state.
  28  *
  29  * @param goal_state The final TAP state.
  30  * @return ERROR_OK on success, or an error code on failure.
  31  *
  32  * The current and goal states must satisfy svf_tap_state_is_stable().
  33  * State transition paths used by this routine are those given in the
  34  * SVF specification for single-argument STATE commands (and also used
  35  * for various other state transitions).
  36  */
  37 int svf_add_statemove(tap_state_t goal_state);
  38
  39 /**
  40  * svf_tap_state_is_stable() returns true for stable non-SHIFT states
  41  *
  42  * @param state The TAP state in question
  43  * @return true iff the state is stable and not a SHIFT state.
  44  */
  45 bool svf_tap_state_is_stable(tap_state_t state);
  46
  47 #endif  /* SVF_H */