X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=src%2Fxsvf%2Fxsvf.c;h=b193509550c6cc422f781773bd6a00246f922c0c;hb=e18bd3b55e3351a38f6bcc5ec17373e022210e9e;hp=1baa1263c6a05e35c8ab858d3a0aed8232cdfeba;hpb=4d88c124b1262a738b4a9f107ef62404a45bf323;p=openocd diff --git a/src/xsvf/xsvf.c b/src/xsvf/xsvf.c index 1baa1263..b1935095 100644 --- a/src/xsvf/xsvf.c +++ b/src/xsvf/xsvf.c @@ -2,7 +2,7 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2007,2008 Øyvind Harboe * * oyvind.harboe@zylin.com * * * * Copyright (C) 2008 Peter Hettkamp * @@ -42,20 +42,7 @@ #endif #include "xsvf.h" - #include "jtag.h" -#include "command.h" -#include "log.h" - -#include -#include -#include -#include -#include -#include - -#include -#include /* XSVF commands, from appendix B of xapp503.pdf */ @@ -95,7 +82,7 @@ ! Set the maximum loop count to 25. LCOUNT 25; -! Step to DRPAUSE give 5 clocks and wait for 1.00e+000 SEC. +! Step to DRPAUSE give 5 clocks and wait for 1.00e + 000 SEC. LDELAY DRPAUSE 5 TCK 1.00E-003 SEC; ! Test for the completed status. Match means pass. ! Loop back to LDELAY line if not match and loop count less than 25. @@ -142,11 +129,11 @@ static int xsvf_fd = 0; /* map xsvf tap state to an openocd "tap_state_t" */ -static tap_state_t xsvf_to_tap( int xsvf_state ) +static tap_state_t xsvf_to_tap(int xsvf_state) { tap_state_t ret; - switch( xsvf_state ) + switch (xsvf_state) { case XSV_RESET: ret = TAP_RESET; break; case XSV_IDLE: ret = TAP_IDLE; break; @@ -165,7 +152,7 @@ static tap_state_t xsvf_to_tap( int xsvf_state ) case XSV_IREXIT2: ret = TAP_IREXIT2; break; case XSV_IRUPDATE: ret = TAP_IRUPDATE; break; default: - LOG_ERROR( "UNKNOWN XSVF STATE 0x%02X", xsvf_state ); + LOG_ERROR("UNKNOWN XSVF STATE 0x%02X", xsvf_state); exit(1); } @@ -173,45 +160,6 @@ static tap_state_t xsvf_to_tap( int xsvf_state ) } -/* xsvf has it's own definition of a statemove. This needs - * to be handled according to the xsvf spec, which has nothing - * to do with the JTAG spec or OpenOCD as such. - * - * Implemented via jtag_add_pathmove(). - */ -static void xsvf_add_statemove(tap_state_t state) -{ - tap_state_t moves[7]; /* max # of transitions */ - tap_state_t curstate = cmd_queue_cur_state; - int i; - - u8 move = tap_get_tms_path(cmd_queue_cur_state, state); - - if (state != TAP_RESET && state==cmd_queue_cur_state) - return; - - if(state==TAP_RESET) - { - jtag_add_tlr(); - return; - } - - for (i=0; i<7; i++) - { - int j = (move >> i) & 1; - if (j) - { - curstate = tap_state_transition(curstate, true); - } - else - { - curstate = tap_state_transition(curstate, false); - } - moves[i] = curstate; - } - - jtag_add_pathmove(7, moves); -} int xsvf_register_commands(struct command_context_s *cmd_ctx) { @@ -221,7 +169,7 @@ int xsvf_register_commands(struct command_context_s *cmd_ctx) return ERROR_OK; } -static int xsvf_read_buffer(int num_bits, int fd, u8* buf) +static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf) { int num_bytes; @@ -236,43 +184,11 @@ static int xsvf_read_buffer(int num_bits, int fd, u8* buf) } -static int xsvf_read_xstates(int fd, tap_state_t *path, int max_path, int *path_len) -{ - char c; - u8 uc; - - while ((read(fd, &c, 1) > 0) && (c == XSTATE)) - { - tap_state_t mystate; - - if (*path_len > max_path) - { - LOG_WARNING("XSTATE path longer than max_path"); - break; - } - if (read(fd, &uc, 1) < 0) - { - return ERROR_XSVF_EOF; - } - - mystate = xsvf_to_tap(uc); - - LOG_DEBUG("XSTATE %02X %s", uc, tap_state_name(mystate) ); - - path[(*path_len)++] = mystate; - } - - lseek(fd, -1, SEEK_CUR); - - return ERROR_OK; -} - - static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { - u8 *dr_out_buf = NULL; /* from host to device (TDI) */ - u8 *dr_in_buf = NULL; /* from device to host (TDO) */ - u8 *dr_in_mask = NULL; + uint8_t *dr_out_buf = NULL; /* from host to device (TDI) */ + uint8_t *dr_in_buf = NULL; /* from device to host (TDO) */ + uint8_t *dr_in_mask = NULL; int xsdrsize = 0; int xruntest = 0; /* number of TCK cycles OR microseconds */ @@ -281,8 +197,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha tap_state_t xendir = TAP_IDLE; /* see page 8 of the SVF spec, initial xendir to be TAP_IDLE */ tap_state_t xenddr = TAP_IDLE; - u8 opcode; - u8 uc; + uint8_t opcode; + uint8_t uc; long file_offset = 0; int loop_count = 0; @@ -316,10 +232,10 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (strcmp(args[0], "plain") != 0) { - tap = jtag_TapByString( args[0] ); - if (!tap ) + tap = jtag_tap_by_string(args[0]); + if (!tap) { - command_print( cmd_ctx, "Tap: %s unknown", args[0] ); + command_print(cmd_ctx, "Tap: %s unknown", args[0]); return ERROR_FAIL; } } @@ -345,7 +261,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_USER("xsvf processing file: \"%s\"", filename); - while( read(xsvf_fd, &opcode, 1) > 0 ) + while (read(xsvf_fd, &opcode, 1) > 0) { /* record the position of the just read opcode within the file */ file_offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1; @@ -371,7 +287,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XRUNTEST: { - u8 xruntest_buf[4]; + uint8_t xruntest_buf[4]; if (read(xsvf_fd, xruntest_buf, 4) < 0) { @@ -386,21 +302,21 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XREPEAT: { - u8 myrepeat; + uint8_t myrepeat; if (read(xsvf_fd, &myrepeat, 1) < 0) do_abort = 1; else { xrepeat = myrepeat; - LOG_DEBUG("XREPEAT %d", xrepeat ); + LOG_DEBUG("XREPEAT %d", xrepeat); } } break; case XSDRSIZE: { - u8 xsdrsize_buf[4]; + uint8_t xsdrsize_buf[4]; if (read(xsvf_fd, xsdrsize_buf, 4) < 0) { @@ -411,9 +327,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha xsdrsize = be_to_h_u32(xsdrsize_buf); LOG_DEBUG("XSDRSIZE %d", xsdrsize); - if( dr_out_buf ) free(dr_out_buf); - if( dr_in_buf) free(dr_in_buf); - if( dr_in_mask) free(dr_in_mask); + if (dr_out_buf) free(dr_out_buf); + if (dr_in_buf) free(dr_in_buf); + if (dr_in_mask) free(dr_in_mask); dr_out_buf = malloc((xsdrsize + 7) / 8); dr_in_buf = malloc((xsdrsize + 7) / 8); @@ -438,7 +354,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (opcode == XSDRTDO) { - if(xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK ) + if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK) { do_abort = 1; break; @@ -450,11 +366,11 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_DEBUG("%s %d", op_name, xsdrsize); - for( attempt=0; attempt0 ) + if (attempt > 0) { /* perform the XC9500 exception handling sequence shown in xapp067.pdf and illustrated in psuedo code at end of this file. We start from state @@ -477,7 +393,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha TAP_IDLE, }; - jtag_add_pathmove( sizeof(exception_path)/sizeof(exception_path[0]), exception_path); + jtag_add_pathmove(DIM(exception_path), exception_path); if (verbose) LOG_USER("%s mismatch, xsdrsize=%d retry=%d", op_name, xsdrsize, attempt); @@ -486,15 +402,17 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha field.tap = tap; field.num_bits = xsdrsize; field.out_value = dr_out_buf; - - field.in_value = NULL; - - jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL); + field.in_value = calloc(CEIL(field.num_bits, 8), 1); if (tap == NULL) - jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE); + jtag_add_plain_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE)); else - jtag_add_dr_scan(1, &field, TAP_DRPAUSE); + jtag_add_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE)); + + jtag_check_value_mask(&field, dr_in_buf, dr_in_mask); + + free(field.in_value); + /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); @@ -507,7 +425,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (!matched) { - LOG_USER( "%s mismatch", op_name); + LOG_USER("%s mismatch", op_name); tdo_mismatch = 1; break; } @@ -515,7 +433,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha /* See page 19 of XSVF spec regarding opcode "XSDR" */ if (xruntest) { - xsvf_add_statemove(TAP_IDLE); + jtag_add_statemove(TAP_IDLE); if (runtest_requires_tck) jtag_add_clocks(xruntest); @@ -523,7 +441,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha jtag_add_sleep(xruntest); } else if (xendir != TAP_DRPAUSE) /* we are already in TAP_DRPAUSE */ - xsvf_add_statemove(xenddr); + jtag_add_statemove(xenddr); } break; @@ -570,8 +488,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XSTATE: { tap_state_t mystate; - tap_state_t* path; - int path_len; + uint8_t uc; if (read(xsvf_fd, &uc, 1) < 0) { @@ -581,40 +498,34 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha mystate = xsvf_to_tap(uc); - LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate) ); + LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate)); - path = calloc(XSTATE_MAX_PATH, 4); - path_len = 1; + /* there is no need for the lookahead code that was here since we + queue up the jtag commands anyway. This is a simple way to handle + the XSTATE. + */ - path[0] = mystate; - if (xsvf_read_xstates(xsvf_fd, path, XSTATE_MAX_PATH, &path_len) != ERROR_OK) - do_abort = 1; - else + if (jtag_add_statemove(mystate) != ERROR_OK) { - int i,lasti; - - /* here the trick is that jtag_add_pathmove() must end in a stable - * state, so we must only invoke jtag_add_tlr() when we absolutely - * have to - */ - for(i=0,lasti=0; ilasti) - { - jtag_add_pathmove(i-lasti,path+lasti); - } - lasti=i+1; - jtag_add_tlr(); - } - } - if(i>=lasti) - { - jtag_add_pathmove(i-lasti, path+lasti); - } + /* For special states known as stable states + (Test-Logic-Reset, Run-Test/Idle, Pause-DR, Pause- IR), + an XSVF interpreter follows predefined TAP state paths + when the starting state is a stable state and when the + XSTATE specifies a new stable state (see the STATE + command in the [Ref 5] for the TAP state paths between + stable states). For non-stable states, XSTATE should + specify a state that is only one TAP state transition + distance from the current TAP state to avoid undefined + TAP state paths. A sequence of multiple XSTATE commands + can be issued to transition the TAP through a specific + state path. + */ + + LOG_ERROR("XSTATE %s is not reachable from current state %s in one clock cycle", + tap_state_name(mystate), + tap_state_name(cmd_queue_cur_state) +); } - free(path); } break; @@ -627,9 +538,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha } /* see page 22 of XSVF spec */ - if( uc == 0 ) + if (uc == 0) xendir = TAP_IDLE; - else if( uc == 1 ) + else if (uc == 1) xendir = TAP_IRPAUSE; else { @@ -650,9 +561,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha } /* see page 22 of XSVF spec */ - if( uc == 0 ) + if (uc == 0) xenddr = TAP_IDLE; - else if( uc == 1 ) + else if (uc == 1) xenddr = TAP_DRPAUSE; else { @@ -667,12 +578,12 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XSIR: case XSIR2: { - u8 short_buf[2]; - u8* ir_buf; + uint8_t short_buf[2]; + uint8_t* ir_buf; int bitcount; tap_state_t my_end_state = xruntest ? TAP_IDLE : xendir; - if( opcode == XSIR ) + if (opcode == XSIR) { /* one byte bitcount */ if (read(xsvf_fd, short_buf, 1) < 0) @@ -694,7 +605,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_DEBUG("XSIR2 %d", bitcount); } - ir_buf = malloc((bitcount+7) / 8); + ir_buf = malloc((bitcount + 7) / 8); if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK) do_abort = 1; @@ -705,12 +616,11 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha field.tap = tap; field.num_bits = bitcount; field.out_value = ir_buf; - + field.in_value = NULL; - field.in_check_value = NULL; - field.in_check_mask = NULL; - field.in_handler = NULL; - field.in_handler_priv = NULL; + + + if (tap == NULL) jtag_add_plain_ir_scan(1, &field, my_end_state); @@ -732,7 +642,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); - if(result != ERROR_OK) + if (result != ERROR_OK) { tdo_mismatch = 1; } @@ -754,32 +664,32 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha break; } - if ( ndx < sizeof(comment)-1 ) + if (ndx < sizeof(comment)-1) comment[ndx++] = uc; } while (uc != 0); comment[sizeof(comment)-1] = 0; /* regardless, terminate */ if (verbose) - LOG_USER("%s", comment); + LOG_USER("# %s", comment); } break; case XWAIT: { /* expected in stream: - XWAIT + XWAIT */ - u8 wait; - u8 end; - u8 delay_buf[4]; + uint8_t wait; + uint8_t end; + uint8_t delay_buf[4]; tap_state_t wait_state; tap_state_t end_state; int delay; - if ( read(xsvf_fd, &wait, 1) < 0 + if (read(xsvf_fd, &wait, 1) < 0 || read(xsvf_fd, &end, 1) < 0 || read(xsvf_fd, delay_buf, 4) < 0) { @@ -793,15 +703,15 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_DEBUG("XWAIT %s %s usecs:%d", tap_state_name(wait_state), tap_state_name(end_state), delay); - if (runtest_requires_tck && wait_state == TAP_IDLE ) + if (runtest_requires_tck && wait_state == TAP_IDLE) { jtag_add_runtest(delay, end_state); } else { - xsvf_add_statemove( wait_state ); + jtag_add_statemove(wait_state); jtag_add_sleep(delay); - xsvf_add_statemove( end_state ); + jtag_add_statemove(end_state); } } break; @@ -809,29 +719,29 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XWAITSTATE: { /* expected in stream: - XWAITSTATE + XWAITSTATE */ - u8 clock_buf[4]; - u8 usecs_buf[4]; - u8 wait; - u8 end; + uint8_t clock_buf[4]; + uint8_t usecs_buf[4]; + uint8_t wait; + uint8_t end; tap_state_t wait_state; tap_state_t end_state; int clock_count; int usecs; - if ( read(xsvf_fd, &wait, 1) < 0 + if (read(xsvf_fd, &wait, 1) < 0 || read(xsvf_fd, &end, 1) < 0 || read(xsvf_fd, clock_buf, 4) < 0 - || read(xsvf_fd, usecs_buf, 4) < 0 ) + || read(xsvf_fd, usecs_buf, 4) < 0) { do_abort = 1; break; } - wait_state = xsvf_to_tap( wait ); - end_state = xsvf_to_tap( end ); + wait_state = xsvf_to_tap(wait); + end_state = xsvf_to_tap(end); clock_count = be_to_h_u32(clock_buf); usecs = be_to_h_u32(usecs_buf); @@ -848,28 +758,28 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha */ if (wait_state != TAP_IRPAUSE && wait_state != TAP_DRPAUSE && wait_state != TAP_RESET && wait_state != TAP_IDLE) { - LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"", tap_state_name( wait_state )); + LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"", tap_state_name(wait_state)); unsupported = 1; } - xsvf_add_statemove( wait_state ); + jtag_add_statemove(wait_state); - jtag_add_clocks( clock_count ); + jtag_add_clocks(clock_count); - jtag_add_sleep( usecs ); + jtag_add_sleep(usecs); - xsvf_add_statemove( end_state ); + jtag_add_statemove(end_state); } break; case LCOUNT: { /* expected in stream: - LCOUNT + LCOUNT */ - u8 count_buf[4]; + uint8_t count_buf[4]; - if ( read(xsvf_fd, count_buf, 4) < 0 ) + if (read(xsvf_fd, count_buf, 4) < 0) { do_abort = 1; break; @@ -883,15 +793,15 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case LDELAY: { /* expected in stream: - LDELAY + LDELAY */ - u8 state; - u8 clock_buf[4]; - u8 usecs_buf[4]; + uint8_t state; + uint8_t clock_buf[4]; + uint8_t usecs_buf[4]; - if ( read(xsvf_fd, &state, 1) < 0 + if (read(xsvf_fd, &state, 1) < 0 || read(xsvf_fd, clock_buf, 4) < 0 - || read(xsvf_fd, usecs_buf, 4) < 0 ) + || read(xsvf_fd, usecs_buf, 4) < 0) { do_abort = 1; break; @@ -916,8 +826,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_DEBUG("LSDR"); - if ( xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK - || xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK ) + if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK + || xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK) { do_abort = 1; break; @@ -926,41 +836,44 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (limit < 1) limit = 1; - for( attempt=0; attempt 0 && verbose) LOG_USER("LSDR retry %d", attempt); - jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL); if (tap == NULL) - jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE); + jtag_add_plain_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE)); else - jtag_add_dr_scan(1, &field, TAP_DRPAUSE); + jtag_add_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE)); + + jtag_check_value_mask(&field, dr_in_buf, dr_in_mask); + + free(field.in_value); + /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); - if(result == ERROR_OK) + if (result == ERROR_OK) { matched = 1; break; } } - if (!matched ) + if (!matched) { - LOG_USER( "LSDR mismatch" ); + LOG_USER("LSDR mismatch"); tdo_mismatch = 1; break; } @@ -969,7 +882,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XTRST: { - u8 trst_mode; + uint8_t trst_mode; if (read(xsvf_fd, &trst_mode, 1) < 0) { @@ -977,7 +890,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha break; } - switch( trst_mode ) + switch (trst_mode) { case XTRST_ON: jtag_add_reset(1, 0); @@ -989,7 +902,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XTRST_ABSENT: break; default: - LOG_ERROR( "XTRST mode argument (0x%02X) out of range", trst_mode ); + LOG_ERROR("XTRST mode argument (0x%02X) out of range", trst_mode); do_abort = 1; } } @@ -1005,7 +918,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_DEBUG("xsvf failed, setting taps to reasonable state"); /* upon error, return the TAPs to a reasonable state */ - xsvf_add_statemove( TAP_IDLE ); + jtag_add_statemove(TAP_IDLE); jtag_execute_queue(); break; } @@ -1014,7 +927,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (tdo_mismatch) { command_print(cmd_ctx, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting", - file_offset ); + file_offset); return ERROR_FAIL; @@ -1022,9 +935,10 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (unsupported) { + off_t offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1; command_print(cmd_ctx, - "unsupported xsvf command: 0x%02X in xsvf file at offset %ld, aborting", - uc, lseek(xsvf_fd, 0, SEEK_CUR)-1 ); + "unsupported xsvf command (0x%02X) at offset %jd, aborting", + uc, (intmax_t)offset); return ERROR_FAIL; }