OpenOCD
interface.h File Reference
Include dependency graph for interface.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  jtag_interface
 Represents a driver for a debugging interface. More...
 

Macros

#define DEBUG_CAP_TMS_SEQ   (1 << 0)
 

Functions

void adapter_assert_reset (void)
 
int adapter_config_trace (bool enabled, enum tpio_pin_protocol pin_protocol, uint32_t port_size, unsigned int *trace_freq)
 
void adapter_deassert_reset (void)
 
int adapter_poll_trace (uint8_t *buf, size_t *size)
 
static tap_state_t jtag_debug_state_machine (const void *tms_buf, const void *tdi_buf, unsigned tap_len, tap_state_t start_tap_state)
 
tap_state_t tap_get_end_state (void)
 For more information,. More...
 
tap_state_t tap_get_state (void)
 This function gets the state of the "state follower" which tracks the state of the TAPs connected to the cable. More...
 
int tap_get_tms_path (tap_state_t from, tap_state_t to)
 This function provides a "bit sequence" indicating what has to be done with TMS during a sequence of seven TAP clock cycles in order to get from state "from" to state "to". More...
 
int tap_get_tms_path_len (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 transition as given by the function tap_get_tms_path(). More...
 
bool tap_is_state_stable (tap_state_t astate)
 Function tap_is_state_stable returns true if the astate is stable. More...
 
int tap_move_ndx (tap_state_t astate)
 Function tap_move_ndx when given a stable state, returns an index from 0-5. More...
 
void tap_set_end_state (tap_state_t new_end_state)
 This function sets the state of an "end state follower" which tracks the state that any cable driver thinks will be the end (resultant) state of the current TAP SIR or SDR operation. More...
 
static void tap_set_state (tap_state_t new_state)
 This function sets the state of a "state follower" which tracks the state of the TAPs connected to the cable. More...
 
void tap_set_state_impl (tap_state_t new_state)
 implementation of wrapper function tap_set_state() More...
 
tap_state_t tap_state_transition (tap_state_t current_state, bool tms)
 Function tap_state_transition takes a current TAP state and returns the next state according to the tms value. More...
 
void tap_use_new_tms_table (bool use_new)
 Allow switching between old and new TMS tables. More...
 
bool tap_uses_new_tms_table (void)
 

Variables

const char *const jtag_only []
 

Macro Definition Documentation

#define DEBUG_CAP_TMS_SEQ   (1 << 0)

Definition at line 206 of file interface.h.

Referenced by jtag_add_tms_seq().

Function Documentation

void adapter_assert_reset ( void  )
int adapter_config_trace ( bool  enabled,
enum tpio_pin_protocol  pin_protocol,
uint32_t  port_size,
unsigned int *  trace_freq 
)

Definition at line 1832 of file jtag/core.c.

References jtag_interface::config_trace, ERROR_FAIL, ERROR_OK, and LOG_ERROR.

Referenced by armv7m_trace_tpiu_config().

void adapter_deassert_reset ( void  )
int adapter_poll_trace ( uint8_t *  buf,
size_t *  size 
)

Definition at line 1846 of file jtag/core.c.

References ERROR_FAIL, and jtag_interface::poll_trace.

Referenced by armv7m_poll_trace().

static tap_state_t jtag_debug_state_machine ( const void *  tms_buf,
const void *  tdi_buf,
unsigned  tap_len,
tap_state_t  start_tap_state 
)
inlinestatic

Definition at line 179 of file interface.h.

Referenced by buspirate_tap_execute(), and jlink_flush().

tap_state_t tap_get_state ( void  )

This function gets the state of the "state follower" which tracks the state of the TAPs connected to the cable.

See Also
tap_set_state
Returns
tap_state_t The state the TAPs are in now.

Definition at line 48 of file interface.c.

References state_follower.

Referenced by amt_jtagaccel_runtest(), amt_jtagaccel_scan(), amt_jtagaccel_state_move(), armjtagew_path_move(), armjtagew_runtest(), armjtagew_scan(), armjtagew_state_move(), bitbang_path_move(), bitbang_runtest(), bitbang_scan(), bitbang_stableclocks(), bitbang_state_move(), bitq_execute_queue(), bitq_path_move(), bitq_runtest(), bitq_scan_field(), bitq_state_move(), buspirate_path_move(), buspirate_runtest(), buspirate_scan(), buspirate_stableclocks(), buspirate_state_move(), cmsis_dap_execute_scan(), cmsis_dap_pathmove(), cmsis_dap_runtest(), cmsis_dap_stableclocks(), cmsis_dap_state_move(), ftdi_execute_pathmove(), ftdi_execute_runtest(), ftdi_execute_scan(), ftdi_execute_sleep(), ftdi_execute_stableclocks(), ftdi_execute_statemove(), gw16012_path_move(), gw16012_runtest(), gw16012_scan(), gw16012_state_move(), jlink_execute_scan(), jlink_path_move(), jlink_runtest(), jlink_stableclocks(), jlink_state_move(), jtag_vpi_path_move(), jtag_vpi_state_move(), move_to_state(), opendous_path_move(), opendous_runtest(), opendous_scan(), opendous_state_move(), openjtag_execute_runtest(), openjtag_execute_scan(), osbdm_add_pathmove(), osbdm_add_scan(), osbdm_add_stableclocks(), osbdm_add_statemove(), rlink_path_move(), rlink_runtest(), rlink_scan(), rlink_state_move(), ublast_path_move(), ublast_state_move(), ulink_queue_pathmove(), ulink_queue_runtest(), ulink_queue_scan(), ulink_queue_stableclocks(), ulink_queue_statemove(), usbprog_path_move(), usbprog_runtest(), usbprog_scan(), usbprog_state_move(), vsllink_execute_queue(), vsllink_path_move(), vsllink_runtest(), vsllink_scan(), vsllink_state_move(), and zy1000_jtag_add_clocks().

int tap_get_tms_path ( tap_state_t  from,
tap_state_t  to 
)

This function provides a "bit sequence" indicating what has to be done with TMS during a sequence of seven TAP clock cycles in order to get from state "from" to state "to".

The length of the sequence must be determined with a parallel call to tap_get_tms_path_len().

Parameters
fromThe starting state.
toThe desired final state.
Returns
int The required TMS bit sequence, with the first bit in the sequence at bit 0.

Definition at line 201 of file interface.c.

References tap_move_ndx(), and tms_seqs.

Referenced by armjtagew_state_move(), bitbang_state_move(), bitq_state_move(), buspirate_state_move(), cmsis_dap_state_move(), gw16012_state_move(), jlink_state_move(), jtag_add_statemove(), jtag_vpi_state_move(), move_to_state(), opendous_state_move(), osbdm_add_statemove(), rlink_state_move(), ublast_state_move(), ulink_queue_scan(), ulink_queue_statemove(), usbprog_state_move(), vsllink_state_move(), and zy1000_jtag_add_clocks().

int tap_get_tms_path_len ( 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 transition as given by the function tap_get_tms_path().

For at least one interface (JLink) it's not OK to simply "pad" TMS sequences to fit a whole byte. (I suspect this is a general TAP problem within OOCD.) Padding TMS causes all manner of instability that's not easily discovered. Using this routine we can apply EXACTLY the state transitions required to make something work - no more - no less.

Parameters
fromis the starting state
tois the resultant or final state
Returns
int - the total number of bits in a transition.

Definition at line 206 of file interface.c.

References tap_move_ndx(), and tms_seqs.

Referenced by armjtagew_state_move(), bitbang_state_move(), bitq_state_move(), buspirate_state_move(), cmsis_dap_state_move(), ftdi_initialize(), gw16012_state_move(), jlink_state_move(), jtag_add_statemove(), jtag_vpi_state_move(), move_to_state(), opendous_state_move(), osbdm_add_statemove(), rlink_state_move(), ublast_state_move(), ulink_queue_scan(), ulink_queue_statemove(), vsllink_state_move(), and zy1000_jtag_add_clocks().

int tap_move_ndx ( tap_state_t  astate)

Function tap_move_ndx when given a stable state, returns an index from 0-5.

The index corresponds to a sequence of stable states which are given in this order:

{ TAP_RESET, TAP_IDLE, TAP_DRSHIFT, TAP_DRPAUSE, TAP_IRSHIFT, TAP_IRPAUSE }

This sequence corresponds to look up tables which are used in some of the cable drivers.

Parameters
astateis the stable state to find in the sequence. If a non stable state is passed, this may cause the program to output an error message and terminate.
Returns
int - the array (or sequence) index as described above

Definition at line 72 of file interface.c.

References LOG_ERROR, TAP_DRPAUSE, TAP_DRSHIFT, TAP_IDLE, TAP_IRPAUSE, TAP_IRSHIFT, TAP_RESET, and tap_state_name().

Referenced by amt_jtagaccel_scan(), amt_jtagaccel_state_move(), tap_get_tms_path(), and tap_get_tms_path_len().

void tap_set_end_state ( tap_state_t  new_end_state)

This function sets the state of an "end state follower" which tracks the state that any cable driver thinks will be the end (resultant) state of the current TAP SIR or SDR operation.

At completion of that TAP operation this value is copied into the state follower via tap_set_state().

Parameters
new_end_stateThe state the TAPs should enter at completion of a pending TAP operation.

Definition at line 59 of file interface.c.

References end_state_follower.

Referenced by amt_jtagaccel_end_state(), armjtagew_end_state(), armjtagew_path_move(), bitbang_end_state(), bitbang_path_move(), bitq_end_state(), bitq_path_move(), buspirate_end_state(), buspirate_path_move(), cmsis_dap_end_state(), ftdi_end_state(), ftdi_execute_pathmove(), gw16012_end_state(), gw16012_path_move(), jlink_end_state(), jlink_path_move(), opendous_end_state(), opendous_path_move(), openjtag_execute_runtest(), openjtag_execute_scan(), openjtag_execute_statemove(), osbdm_add_pathmove(), osbdm_add_scan(), osbdm_add_statemove(), rlink_end_state(), rlink_path_move(), ulink_queue_runtest(), ulink_queue_scan(), ulink_set_end_state(), usbprog_end_state(), usbprog_path_move(), vsllink_end_state(), and vsllink_path_move().

static void tap_set_state ( tap_state_t  new_state)
inlinestatic

This function sets the state of a "state follower" which tracks the state of the TAPs connected to the cable.

The state follower is hopefully always in the same state as the actual TAPs in the jtag chain, and will be so if there are no bugs in the tracking logic within that cable driver.

All the cable drivers call this function to indicate the state they think the TAPs attached to their cables are in. Because this function can also log transitions, it will be helpful to call this function with every transition that the TAPs being manipulated are expected to traverse, not just end points of a multi-step state path.

Parameters
new_stateThe state we think the TAPs are currently in (or are about to enter).

Definition at line 66 of file interface.h.

References tap_set_state_impl().

Referenced by amt_jtagaccel_execute_queue(), amt_jtagaccel_scan(), amt_jtagaccel_state_move(), armjtagew_execute_queue(), armjtagew_path_move(), armjtagew_scan(), armjtagew_state_move(), bitbang_execute_queue(), bitbang_path_move(), bitbang_state_move(), bitq_execute_queue(), bitq_path_move(), bitq_scan_field(), bitq_state_move(), buspirate_execute_queue(), buspirate_path_move(), buspirate_scan(), buspirate_state_move(), cmsis_dap_execute_scan(), cmsis_dap_execute_tlr_reset(), cmsis_dap_pathmove(), cmsis_dap_state_move(), ftdi_execute_pathmove(), ftdi_execute_reset(), ftdi_execute_scan(), gw16012_execute_queue(), gw16012_path_move(), gw16012_scan(), gw16012_state_move(), jlink_execute_scan(), jlink_path_move(), jlink_state_move(), jtag_add_reset(), jtag_vpi_path_move(), jtag_vpi_scan(), jtag_vpi_state_move(), move_to_state(), opendous_execute_queue(), opendous_path_move(), opendous_scan(), opendous_state_move(), openjtag_execute_runtest(), openjtag_execute_scan(), openjtag_execute_statemove(), osbdm_add_pathmove(), osbdm_add_statemove(), rlink_execute_queue(), rlink_path_move(), rlink_scan(), rlink_state_move(), ublast_init(), ublast_initial_wipeout(), ublast_path_move(), ublast_scan(), ublast_state_move(), ulink_queue_pathmove(), ulink_queue_reset(), ulink_queue_scan(), ulink_queue_statemove(), ulink_queue_tlr_reset(), usbprog_execute_queue(), usbprog_path_move(), usbprog_scan(), usbprog_state_move(), vsllink_execute_queue(), vsllink_path_move(), vsllink_scan(), and vsllink_state_move().

void tap_set_state_impl ( tap_state_t  new_state)

implementation of wrapper function tap_set_state()

Definition at line 42 of file interface.c.

References state_follower.

Referenced by tap_set_state().

tap_state_t tap_state_transition ( tap_state_t  current_state,
bool  tms 
)
void tap_use_new_tms_table ( bool  use_new)

Allow switching between old and new TMS tables.

See Also
tap_get_tms_path

Definition at line 461 of file interface.c.

References old_tms_seqs, and tms_seqs.

Referenced by COMMAND_HANDLER().

bool tap_uses_new_tms_table ( void  )
Returns
True if new TMS table is active; false otherwise.

Definition at line 465 of file interface.c.

References short_tms_seqs, and tms_seqs.

Referenced by COMMAND_HANDLER().

Variable Documentation

const char* const jtag_only[]

Definition at line 49 of file adapter.c.

Referenced by adapter_init(), and COMMAND_HANDLER().