X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fjtag%2Finterface.h;h=8dacd22348e4a858c91f65d1041e2db32a1cb2c6;hp=83ff6fa4fb940a2e4e76a0612181a6aa5662936c;hb=4dc8cd201c667bac72bc083ef1fa1b285eb093fc;hpb=41018ff44b5393137c6bd41701d9c72780a65a0a diff --git a/src/jtag/interface.h b/src/jtag/interface.h index 83ff6fa4fb..8dacd22348 100644 --- a/src/jtag/interface.h +++ b/src/jtag/interface.h @@ -21,12 +21,13 @@ * 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. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifndef OPENOCD_JTAG_INTERFACE_H #define OPENOCD_JTAG_INTERFACE_H -#include "jtag.h" +#include /* @file * The "Cable Helper API" is what the cable drivers can use to help @@ -54,12 +55,12 @@ void tap_set_state_impl(tap_state_t new_state); * expected to traverse, not just end points of a multi-step state path. * * @param new_state The state we think the TAPs are currently in (or - * are about to enter). + * are about to enter). */ #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 @@ -85,7 +86,7 @@ tap_state_t tap_get_state(void); * state follower via tap_set_state(). * * @param new_end_state The state the TAPs should enter at completion of - * a pending TAP operation. + * a pending TAP operation. */ void tap_set_end_state(tap_state_t new_end_state); @@ -106,11 +107,10 @@ tap_state_t tap_get_end_state(void); * @param from The starting state. * @param to The desired final state. * @return int The required TMS bit sequence, with the first bit in the - * sequence at bit 0. + * sequence at bit 0. */ int tap_get_tms_path(tap_state_t from, tap_state_t to); - /** * Function int tap_get_tms_path_len * returns the total number of bits that represents a TMS path @@ -160,12 +160,9 @@ bool tap_is_state_stable(tap_state_t astate); */ tap_state_t tap_state_transition(tap_state_t current_state, bool tms); -/// 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 +/** 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. +/** @returns True if new TMS table is active; false otherwise. */ bool tap_uses_new_tms_table(void); #ifdef _DEBUG_JTAG_IO_ @@ -185,12 +182,34 @@ static inline tap_state_t jtag_debug_state_machine(const void *tms_buf, { return start_tap_state; } -#endif // _DEBUG_JTAG_IO_ +#endif /* _DEBUG_JTAG_IO_ */ -typedef struct jtag_interface_s -{ - /// The name of the JTAG interface driver. - char* name; +/** + * Represents a driver for a debugging interface. + * + * @todo Rename; perhaps "debug_driver". This isn't an interface, + * it's a driver! Also, not all drivers support JTAG. + * + * @todo We need a per-instance structure too, and changes to pass + * that structure to the driver. Instances can for example be in + * either SWD or JTAG modes. This will help remove globals, and + * eventually to cope with systems which have more than one such + * debugging interface. + */ +struct jtag_interface { + /** The name of the JTAG interface driver. */ + char *name; + + /** + * Bit vector listing capabilities exposed by this driver. + */ + unsigned supported; +#define DEBUG_CAP_TMS_SEQ (1 << 0) + + /** transports supported in C code (NULL terminated vector) */ + const char **transports; + + const struct swd_driver *swd; /** * Execute queued commands. @@ -208,14 +227,18 @@ typedef struct jtag_interface_s /** * 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); + const struct command_registration *commands; /** - * Interface driver must initalize any resources and connect to a + * Interface driver must initialize any resources and connect to a * JTAG device. + * + * quit() is invoked if and only if init() succeeds. quit() is always + * invoked if init() succeeds. Same as malloc() + free(). Always + * invoke free() if malloc() succeeds and do not invoke free() + * otherwise. + * * @returns ERROR_OK on success, or an error code on failure. */ int (*init)(void); @@ -223,12 +246,13 @@ typedef struct jtag_interface_s /** * 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 @@ -237,7 +261,7 @@ typedef struct jtag_interface_s * and use a fallback kHz TCK. * @returns ERROR_OK on success, or an error code on failure. */ - int (*khz)(int khz, int* jtag_speed); + int (*khz)(int khz, int *jtag_speed); /** * Calculate the clock frequency (in KHz) for the given @a speed. @@ -246,7 +270,7 @@ typedef struct jtag_interface_s * @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); + int (*speed_div)(int speed, int *khz); /** * Read and clear the power dropout flag. Note that a power dropout @@ -259,7 +283,7 @@ typedef struct jtag_interface_s * * @returns ERROR_OK on success, or an error code on failure. */ - int (*power_dropout)(int* power_dropout); + int (*power_dropout)(int *power_dropout); /** * Read and clear the srst asserted detection flag. @@ -273,8 +297,12 @@ typedef struct jtag_interface_s * been asserted. * @returns ERROR_OK on success, or an error code on failure. */ - int (*srst_asserted)(int* srst_asserted); -} jtag_interface_t; + int (*srst_asserted)(int *srst_asserted); +}; + +extern const char *jtag_only[]; +void adapter_assert_reset(void); +void adapter_deassert_reset(void); -#endif // OPENOCD_JTAG_INTERFACE_H +#endif /* OPENOCD_JTAG_INTERFACE_H */