X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fjtag%2Fjtag.h;h=19329447735806bfc481d76a1e616d871344f102;hp=ad038ae5f03f98ee6a44a086632e87bc65172a67;hb=eabb49b570290f2bcda80a0c591431b7ef240d43;hpb=4102c784321e68d8d82174148a51d4bcd8f14c82 diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h index ad038ae5f0..1932944773 100644 --- a/src/jtag/jtag.h +++ b/src/jtag/jtag.h @@ -22,10 +22,11 @@ #include "types.h" #include "binarybuffer.h" +#include "log.h" #include "command.h" -#if 1 +#if 0 #define _DEBUG_JTAG_IO_ #endif @@ -59,8 +60,16 @@ extern tap_transition_t tap_transitions[16]; /* describe the TAP state diagram * extern enum tap_state end_state; /* finish DR scans in dr_end_state */ extern enum tap_state cur_state; /* current TAP state */ +extern enum tap_state cmd_queue_end_state; /* finish DR scans in dr_end_state */ +extern enum tap_state cmd_queue_cur_state; /* current TAP state */ + #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]] +typedef void * error_handler_t; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */ + +struct scan_field_s; +typedef int (*in_handler_t)(u8 *in_value, void *priv, struct scan_field_s *field); + typedef struct scan_field_s { int device; /* ordinal device number this instruction refers to */ @@ -68,12 +77,14 @@ typedef struct scan_field_s u8 *out_value; /* value to be scanned into the device */ u8 *out_mask; /* only masked bits care */ u8 *in_value; /* pointer to a 32-bit memory location to take data scanned out */ - u8 *in_check_value; /* used to validate scan results */ - u8 *in_check_mask; /* check specified bits against check_value */ - int (*in_handler)(u8 *in_value, void *priv); /* process received buffer using this handler */ + /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage */ + u8 *in_check_value; /* used to validate scan results */ + u8 *in_check_mask; /* check specified bits against check_value */ + in_handler_t in_handler; /* process received buffer using this handler */ void *in_handler_priv; /* additional information for the in_handler */ } scan_field_t; + enum scan_type { /* IN: from device to host, OUT: from host to device */ @@ -178,25 +189,21 @@ typedef struct jtag_interface_s */ int (*execute_queue)(void); - /* optional command support - */ - int support_pathmove; - /* interface initalization */ int (*speed)(int speed); int (*register_commands)(struct command_context_s *cmd_ctx); int (*init)(void); int (*quit)(void); + /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns + a failure if it can't support the KHz/RTCK. */ + int (*khz)(int khz, int *jtag_speed); } jtag_interface_t; enum jtag_event { - JTAG_SRST_ASSERTED, - JTAG_TRST_ASSERTED, - JTAG_SRST_RELEASED, - JTAG_TRST_RELEASED, + JTAG_TRST_ASSERTED }; extern char* jtag_event_strings[]; @@ -217,8 +224,8 @@ extern jtag_interface_t *jtag; /* global pointer to configured JTAG interface */ extern enum tap_state end_state; extern enum tap_state cur_state; -extern char* jtag_interface; extern int jtag_speed; +extern int jtag_speed_post_reset; enum reset_types { @@ -238,21 +245,129 @@ extern enum reset_types jtag_reset_config; extern int jtag_init(struct command_context_s *cmd_ctx); extern int jtag_register_commands(struct command_context_s *cmd_ctx); -/* JTAG interface */ -extern int jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); -extern int jtag_add_statemove(enum tap_state endstate); -extern int jtag_add_pathmove(int num_states, enum tap_state *path); -extern int jtag_add_runtest(int num_cycles, enum tap_state endstate); -extern int jtag_add_reset(int trst, int srst); -extern int jtag_add_end_state(enum tap_state endstate); -extern int jtag_add_sleep(u32 us); +/* JTAG interface, can be implemented with a software or hardware fifo + * + * TAP_SD and TAP_SI are illegal end states. TAP_SD/SI as end states + * can be emulated by using a larger scan. + * + * Code that is relatively insensitive to the path(as long + * as it is JTAG compliant) taken through state machine can use + * endstate for jtag_add_xxx_scan(). Otherwise the pause state must be + * specified as end state and a subsequent jtag_add_pathmove() must + * be issued. + * + */ +extern void jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +extern int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +extern void jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +extern int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +extern void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +extern int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +extern void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate); +/* run a TAP_TLR reset. End state is TAP_TLR, regardless + * of start state. + */ +extern void jtag_add_tlr(); +extern int interface_jtag_add_tlr(); +/* Do not use jtag_add_pathmove() unless you need to, but do use it + * if you have to. + * + * DANGER! If the target is dependent upon a particular sequence + * of transitions for things to work correctly(e.g. as a workaround + * for an errata that contradicts the JTAG standard), then pathmove + * must be used, even if some jtag interfaces happen to use the + * desired path. Worse, the jtag interface used for testing a + * particular implementation, could happen to use the "desired" + * path when transitioning to/from end + * state. + * + * A list of unambigious single clock state transitions, not + * all drivers can support this, but it is required for e.g. + * XScale and Xilinx support + * + * Note! TAP_TLR must not be used in the path! + * + * Note that the first on the list must be reachable + * via a single transition from the current state. + * + * All drivers are required to implement jtag_add_pathmove(). + * However, if the pathmove sequence can not be precisely + * executed, an interface_jtag_add_pathmove() or jtag_execute_queue() + * must return an error. It is legal, but not recommended, that + * a driver returns an error in all cases for a pathmove if it + * can only implement a few transitions and therefore + * a partial implementation of pathmove would have little practical + * application. + */ +extern void jtag_add_pathmove(int num_states, enum tap_state *path); +extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path); +/* go to TAP_RTI, if we're not already there and cycle + * precisely num_cycles in the TAP_RTI after which move + * to the end state, if it is != TAP_RTI + */ +extern void jtag_add_runtest(int num_cycles, enum tap_state endstate); +extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate); +/* A reset of the TAP state machine can be requested. + * + * Whether tms or trst reset is used depends on the capabilities of + * the target and jtag interface(reset_config command configures this). + * + * srst can driver a reset of the TAP state machine and vice + * versa + * + * Application code may need to examine value of jtag_reset_config + * to determine the proper codepath + * + * DANGER! Even though srst drives trst, trst might not be connected to + * the interface, and it might actually be *harmful* to assert trst in this case. + * + * This is why combinations such as "reset_config srst_only srst_pulls_trst" + * are supported. + * + */ +extern void jtag_add_reset(int req_tlr_or_trst, int srst); +/* this drives the actual srst and trst pins. srst will always be 0 + * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for + * trst. + * + * the higher level jtag_add_reset will invoke jtag_add_tlr() if + * approperiate + */ +extern int interface_jtag_add_reset(int trst, int srst); +extern void jtag_add_end_state(enum tap_state endstate); +extern int interface_jtag_add_end_state(enum tap_state endstate); +extern void jtag_add_sleep(u32 us); +extern int interface_jtag_add_sleep(u32 us); + + + +/* + * For software FIFO implementations, the queued commands can be executed + * during this call or earlier. A sw queue might decide to push out + * some of the jtag_add_xxx() operations once the queue is "big enough". + * + * This fn will return an error code if any of the prior jtag_add_xxx() + * calls caused a failure, e.g. check failure. Note that it does not + * matter if the operation was executed *before* jtag_execute_queue(), + * jtag_execute_queue() will still return an error code. + * + * All jtag_add_xxx() calls that have in_handler!=NULL will have been + * executed when this fn returns, but if what has been queued only + * clocks data out, without reading anything back, then JTAG could + * be running *after* jtag_execute_queue() returns. The API does + * not define a way to flush a hw FIFO that runs *after* + * jtag_execute_queue() returns. + * + * jtag_add_xxx() commands can either be executed immediately or + * at some time between the jtag_add_xxx() fn call and jtag_execute_queue(). + */ extern int jtag_execute_queue(void); -extern int jtag_cancel_queue(void); +/* can be implemented by hw+sw */ +extern int interface_jtag_execute_queue(void); /* JTAG support functions */ +extern void jtag_set_check_value(scan_field_t *field, u8 *value, u8 *mask, error_handler_t *in_error_handler); extern enum scan_type jtag_scan_type(scan_command_t *cmd); extern int jtag_scan_size(scan_command_t *cmd); extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd); @@ -262,6 +377,8 @@ extern void jtag_sleep(u32 us); extern int jtag_call_event_callbacks(enum jtag_event event); extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv); +extern int jtag_verify_capture_ir; + /* error codes * JTAG subsystem uses codes between -100 and -199 */ @@ -270,7 +387,55 @@ extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, v #define ERROR_JTAG_NOT_IMPLEMENTED (-102) #define ERROR_JTAG_TRST_ASSERTED (-103) #define ERROR_JTAG_QUEUE_FAILED (-104) -#define ERROR_JTAG_RESET_WOULD_ASSERT_TRST (-105) -#define ERROR_JTAG_RESET_CANT_SRST (-106) #define ERROR_JTAG_DEVICE_ERROR (-107) + + + +/* this allows JTAG devices to implement the entire jtag_xxx() layer in hw/sw */ +#ifdef HAVE_JTAG_MINIDRIVER_H +/* Here a #define MINIDRIVER() and an inline version of hw fifo interface_jtag_add_dr_out can be defined */ +#include "jtag_minidriver.h" +#define MINIDRIVER(a) notused ## a +#else +#define MINIDRIVER(a) a +/* jtag_add_dr_out() is a faster version of jtag_add_dr_scan() + * + * Current or end_state can not be TAP_TLR. end_state can be -1 + * + * num_bits[i] is the number of bits to clock out from value[i] LSB first. + * + * If the device is in bypass, then that is an error condition in + * the caller code that is not detected by this fn, whereas jtag_add_dr_scan() + * does detect it. Similarly if the device is not in bypass, data must + * be passed to it. + * + * If anything fails, then jtag_error will be set and jtag_execute() will + * return an error. There is no way to determine if there was a failure + * during this function call. + * + * Note that this jtag_add_dr_out can be defined as an inline function. + */ +extern void interface_jtag_add_dr_out(int device, + int num_fields, + int *num_bits, + u32 *value, + enum tap_state end_state); +#endif + + + + +static __inline__ void jtag_add_dr_out(int device, + int num_fields, + int *num_bits, + u32 *value, + enum tap_state end_state) +{ + if (end_state != -1) + cmd_queue_end_state=end_state; + cmd_queue_cur_state=cmd_queue_end_state; + interface_jtag_add_dr_out(device, num_fields, num_bits, value, cmd_queue_end_state); +} + + #endif /* JTAG_H */