int fileio_read_u32(struct fileio *fileio_p, uint32_t *data) { uint8_t buf[4]; size_t size_read; struct fileio_internal *fileio = fileio_p->fp; int retval = fileio_local_read(fileio, sizeof(uint32_t), buf, &size_read); if (ERROR_OK == retval && sizeof(uint32_t) != size_read) retval = -EIO; if (ERROR_OK == retval) *data = be_to_h_u32(buf); return retval; }
int fileio_read_u32(fileio_t *fileio, u32 *data) { u8 buf[4]; u32 size_read; int retval; if ((retval = fileio_local_read(fileio, 4, buf, &size_read)) != ERROR_OK) return retval; *data = be_to_h_u32(buf); return ERROR_OK; }
static int read_section(FILE *input_file, int length_size, char section, uint32_t *buffer_length, uint8_t **buffer) { uint8_t length_buffer[4]; int length; char section_char; int read_count; if ((length_size != 2) && (length_size != 4)) { LOG_ERROR("BUG: length_size neither 2 nor 4"); return ERROR_PLD_FILE_LOAD_FAILED; } if ((read_count = fread(§ion_char, 1, 1, input_file)) != 1) { return ERROR_PLD_FILE_LOAD_FAILED; } if (section_char != section) { return ERROR_PLD_FILE_LOAD_FAILED; } if ((read_count = fread(length_buffer, 1, length_size, input_file)) != length_size) { return ERROR_PLD_FILE_LOAD_FAILED; } if (length_size == 4) length = be_to_h_u32(length_buffer); else /* (length_size == 2) */ length = be_to_h_u16(length_buffer); if (buffer_length) *buffer_length = length; *buffer = malloc(length); if ((read_count = fread(*buffer, 1, length, input_file)) != length) { return ERROR_PLD_FILE_LOAD_FAILED; } return ERROR_OK; }
/* The Cortex M3 will indicate that an alignment adjustment * has been done on the stack by setting bit 9 of the stacked xPSR * register. In this case, we can just add an extra 4 bytes to get * to the program stack. Note that some places in the ARM documentation * make this a little unclear but the padding takes place before the * normal exception stacking - so xPSR is always available at a fixed * location. * * Relevant documentation: * Cortex-M series processors -> Cortex-M3 -> Revision: xxx -> * Cortex-M3 Devices Generic User Guide -> The Cortex-M3 Processor -> * Exception Model -> Exception entry and return -> Exception entry * Cortex-M series processors -> Cortex-M3 -> Revision: xxx -> * Cortex-M3 Devices Generic User Guide -> Cortex-M3 Peripherals -> * System control block -> Configuration and Control Register (STKALIGN) * * This is just a helper function for use in the calculate_process_stack * function for a given architecture/rtos. */ int64_t rtos_Cortex_M_stack_align(struct target *target, const uint8_t *stack_data, const struct rtos_register_stacking *stacking, int64_t stack_ptr, size_t xpsr_offset) { const uint32_t ALIGN_NEEDED = (1 << 9); uint32_t xpsr; int64_t new_stack_ptr; new_stack_ptr = stack_ptr - stacking->stack_growth_direction * stacking->stack_registers_size; xpsr = (target->endianness == TARGET_LITTLE_ENDIAN) ? le_to_h_u32(&stack_data[xpsr_offset]) : be_to_h_u32(&stack_data[xpsr_offset]); if ((xpsr & ALIGN_NEEDED) != 0) { LOG_DEBUG("XPSR(0x%08" PRIx32 ") indicated stack alignment was necessary\r\n", xpsr); new_stack_ptr -= (stacking->stack_growth_direction * 4); } return new_stack_ptr; }
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; int xsdrsize = 0; int xruntest = 0; /* number of TCK cycles OR microseconds */ int xrepeat = 0; /* number of retries */ 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; long file_offset = 0; int loop_count = 0; tap_state_t loop_state = TAP_IDLE; int loop_clocks = 0; int loop_usecs = 0; int do_abort = 0; int unsupported = 0; int tdo_mismatch = 0; int result; int verbose = 1; char* filename; int runtest_requires_tck = 0; /* a flag telling whether to clock TCK during waits, or simply sleep, controled by virt2 */ /* use NULL to indicate a "plain" xsvf file which accounts for additional devices in the scan chain, otherwise the device that should be affected */ jtag_tap_t *tap = NULL; if (argc < 2) { command_print(cmd_ctx, "usage: xsvf <device#|plain> <file> [<variant>] [quiet]"); return ERROR_FAIL; } filename = args[1]; /* we mess with args starting point below, snapshot filename here */ if (strcmp(args[0], "plain") != 0) { tap = jtag_TapByString( args[0] ); if (!tap ) { command_print( cmd_ctx, "Tap: %s unknown", args[0] ); return ERROR_FAIL; } } if ((xsvf_fd = open(filename, O_RDONLY)) < 0) { command_print(cmd_ctx, "file \"%s\" not found", filename); return ERROR_FAIL; } /* if this argument is present, then interpret xruntest counts as TCK cycles rather than as usecs */ if ((argc > 2) && (strcmp(args[2], "virt2") == 0)) { runtest_requires_tck = 1; --argc; ++args; } if ((argc > 2) && (strcmp(args[2], "quiet") == 0)) { verbose = 0; } LOG_USER("xsvf processing file: \"%s\"", filename); 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; switch (opcode) { case XCOMPLETE: LOG_DEBUG("XCOMPLETE"); result = jtag_execute_queue(); if (result != ERROR_OK) { tdo_mismatch = 1; break; } break; case XTDOMASK: LOG_DEBUG("XTDOMASK"); if (dr_in_mask && (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_mask) != ERROR_OK)) do_abort = 1; break; case XRUNTEST: { u8 xruntest_buf[4]; if (read(xsvf_fd, xruntest_buf, 4) < 0) { do_abort = 1; break; } xruntest = be_to_h_u32(xruntest_buf); LOG_DEBUG("XRUNTEST %d 0x%08X", xruntest, xruntest); } break; case XREPEAT: { u8 myrepeat; if (read(xsvf_fd, &myrepeat, 1) < 0) do_abort = 1; else { xrepeat = myrepeat; LOG_DEBUG("XREPEAT %d", xrepeat ); } } break; case XSDRSIZE: { u8 xsdrsize_buf[4]; if (read(xsvf_fd, xsdrsize_buf, 4) < 0) { do_abort = 1; break; } 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); dr_out_buf = malloc((xsdrsize + 7) / 8); dr_in_buf = malloc((xsdrsize + 7) / 8); dr_in_mask = malloc((xsdrsize + 7) / 8); } break; case XSDR: /* these two are identical except for the dr_in_buf */ case XSDRTDO: { int limit = xrepeat; int matched = 0; int attempt; const char* op_name = (opcode == XSDR ? "XSDR" : "XSDRTDO"); if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK) { do_abort = 1; break; } if (opcode == XSDRTDO) { if(xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK ) { do_abort = 1; break; } } if (limit < 1) limit = 1; LOG_DEBUG("%s %d", op_name, xsdrsize); for( attempt=0; attempt<limit; ++attempt ) { scan_field_t field; 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 DRPAUSE: go to Exit2-DR go to Shift-DR go to Exit1-DR go to Update-DR go to Run-Test/Idle This sequence should be harmless for other devices, and it will be skipped entirely if xrepeat is set to zero. */ static tap_state_t exception_path[] = { TAP_DREXIT2, TAP_DRSHIFT, TAP_DREXIT1, TAP_DRUPDATE, TAP_IDLE, }; jtag_add_pathmove( sizeof(exception_path)/sizeof(exception_path[0]), exception_path); if (verbose) LOG_USER("%s %d retry %d", op_name, xsdrsize, attempt); } field.tap = tap; field.num_bits = xsdrsize; field.out_value = dr_out_buf; field.out_mask = NULL; field.in_value = NULL; jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL); if (tap == NULL) jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE); else jtag_add_dr_scan(1, &field, TAP_DRPAUSE); /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); if (result == ERROR_OK) { matched = 1; break; } } if (!matched) { LOG_USER( "%s mismatch", op_name); tdo_mismatch = 1; break; } /* See page 19 of XSVF spec regarding opcode "XSDR" */ if (xruntest) { xsvf_add_statemove(TAP_IDLE); if (runtest_requires_tck) jtag_add_clocks(xruntest); else jtag_add_sleep(xruntest); } else if (xendir != TAP_DRPAUSE) /* we are already in TAP_DRPAUSE */ xsvf_add_statemove(xenddr); } break; case XSETSDRMASKS: LOG_ERROR("unsupported XSETSDRMASKS\n"); unsupported = 1; break; case XSDRINC: LOG_ERROR("unsupported XSDRINC\n"); unsupported = 1; break; case XSDRB: LOG_ERROR("unsupported XSDRB\n"); unsupported = 1; break; case XSDRC: LOG_ERROR("unsupported XSDRC\n"); unsupported = 1; break; case XSDRE: LOG_ERROR("unsupported XSDRE\n"); unsupported = 1; break; case XSDRTDOB: LOG_ERROR("unsupported XSDRTDOB\n"); unsupported = 1; break; case XSDRTDOC: LOG_ERROR("unsupported XSDRTDOC\n"); unsupported = 1; break; case XSDRTDOE: LOG_ERROR("unsupported XSDRTDOE\n"); unsupported = 1; break; case XSTATE: { tap_state_t mystate; tap_state_t *path; int path_len; if (read(xsvf_fd, &uc, 1) < 0) { do_abort = 1; break; } mystate = xsvf_to_tap(uc); LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate) ); path = calloc(XSTATE_MAX_PATH, 4); path_len = 1; path[0] = mystate; if (xsvf_read_xstates(xsvf_fd, path, XSTATE_MAX_PATH, &path_len) != ERROR_OK) do_abort = 1; else { 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; i<path_len; i++) { if(path[i]==TAP_RESET) { if(i>lasti) { jtag_add_pathmove(i-lasti,path+lasti); } lasti=i+1; jtag_add_tlr(); } } if(i>=lasti) { jtag_add_pathmove(i-lasti, path+lasti); } } free(path); } break; case XENDIR: { tap_state_t mystate; if (read(xsvf_fd, &uc, 1) < 0) { do_abort = 1; break; } /* see page 22 of XSVF spec */ mystate = uc == 1 ? TAP_IRPAUSE : TAP_IDLE; LOG_DEBUG("XENDIR 0x%02X %s", uc, tap_state_name(mystate)); /* assuming that the XRUNTEST comes from SVF RUNTEST, then only these states * should come here because the SVF spec only allows these with a RUNTEST */ if (mystate != TAP_IRPAUSE && mystate != TAP_DRPAUSE && mystate != TAP_RESET && mystate != TAP_IDLE ) { LOG_ERROR("illegal XENDIR endstate: \"%s\"", tap_state_name(mystate)); unsupported = 1; break; } xendir = mystate; } break; case XENDDR: { tap_state_t mystate; if (read(xsvf_fd, &uc, 1) < 0) { do_abort = 1; break; } /* see page 22 of XSVF spec */ mystate = uc == 1 ? TAP_DRPAUSE : TAP_IDLE; LOG_DEBUG("XENDDR %02X %s", uc, tap_state_name(mystate)); if (mystate != TAP_IRPAUSE && mystate != TAP_DRPAUSE && mystate != TAP_RESET && mystate != TAP_IDLE ) { LOG_ERROR("illegal XENDDR endstate: \"%s\"", tap_state_name( mystate )); unsupported = 1; break; } xenddr = mystate; } break; case XSIR: case XSIR2: { u8 short_buf[2]; u8* ir_buf; int bitcount; tap_state_t my_end_state = xruntest ? TAP_IDLE : xendir; if( opcode == XSIR ) { /* one byte bitcount */ if (read(xsvf_fd, short_buf, 1) < 0) { do_abort = 1; break; } bitcount = short_buf[0]; LOG_DEBUG("XSIR %d", bitcount); } else { if (read(xsvf_fd, short_buf, 2) < 0) { do_abort = 1; break; } bitcount = be_to_h_u16(short_buf); LOG_DEBUG("XSIR2 %d", bitcount); } ir_buf = malloc((bitcount+7) / 8); if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK) do_abort = 1; else { scan_field_t field; field.tap = tap; field.num_bits = bitcount; field.out_value = ir_buf; field.out_mask = NULL; 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); else jtag_add_ir_scan(1, &field, my_end_state); if (xruntest) { if (runtest_requires_tck) jtag_add_clocks(xruntest); else jtag_add_sleep(xruntest); } /* Note that an -irmask of non-zero in your config file * can cause this to fail. Setting -irmask to zero cand work * around the problem. */ /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); if(result != ERROR_OK) { tdo_mismatch = 1; } } free(ir_buf); } break; case XCOMMENT: { int ndx = 0; char comment[128]; do { if (read(xsvf_fd, &uc, 1) < 0) { do_abort = 1; break; } if ( ndx < sizeof(comment)-1 ) comment[ndx++] = uc; } while (uc != 0); comment[sizeof(comment)-1] = 0; /* regardless, terminate */ if (verbose) LOG_USER(comment); } break; case XWAIT: { /* expected in stream: XWAIT <u8 wait_state> <u8 end_state> <u32 usecs> */ u8 wait; u8 end; u8 delay_buf[4]; tap_state_t wait_state; tap_state_t end_state; int delay; if ( read(xsvf_fd, &wait, 1) < 0 || read(xsvf_fd, &end, 1) < 0 || read(xsvf_fd, delay_buf, 4) < 0) { do_abort = 1; break; } wait_state = xsvf_to_tap(wait); end_state = xsvf_to_tap(end); delay = be_to_h_u32(delay_buf); 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 ) { jtag_add_runtest(delay, end_state); } else { xsvf_add_statemove( wait_state ); jtag_add_sleep(delay); xsvf_add_statemove( end_state ); } } break; case XWAITSTATE: { /* expected in stream: XWAITSTATE <u8 wait_state> <u8 end_state> <u32 clock_count> <u32 usecs> */ u8 clock_buf[4]; u8 usecs_buf[4]; u8 wait; u8 end; tap_state_t wait_state; tap_state_t end_state; int clock_count; int usecs; 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 ) { do_abort = 1; break; } 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); LOG_DEBUG("XWAITSTATE %s %s clocks:%i usecs:%i", tap_state_name(wait_state), tap_state_name(end_state), clock_count, usecs); /* the following states are 'stable', meaning that they have a transition * in the state diagram back to themselves. This is necessary because we will * be issuing a number of clocks in this state. This set of allowed states is also * determined by the SVF RUNTEST command's allowed states. */ 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 )); unsupported = 1; } xsvf_add_statemove( wait_state ); jtag_add_clocks( clock_count ); jtag_add_sleep( usecs ); xsvf_add_statemove( end_state ); } break; case LCOUNT: { /* expected in stream: LCOUNT <u32 loop_count> */ u8 count_buf[4]; if ( read(xsvf_fd, count_buf, 4) < 0 ) { do_abort = 1; break; } loop_count = be_to_h_u32(count_buf); LOG_DEBUG("LCOUNT %d", loop_count); } break; case LDELAY: { /* expected in stream: LDELAY <u8 wait_state> <u32 clock_count> <u32 usecs_to_sleep> */ u8 state; u8 clock_buf[4]; u8 usecs_buf[4]; if ( read(xsvf_fd, &state, 1) < 0 || read(xsvf_fd, clock_buf, 4) < 0 || read(xsvf_fd, usecs_buf, 4) < 0 ) { do_abort = 1; break; } loop_state = xsvf_to_tap(state); loop_clocks = be_to_h_u32(clock_buf); loop_usecs = be_to_h_u32(usecs_buf); LOG_DEBUG("LDELAY %s clocks:%d usecs:%d", tap_state_name(loop_state), loop_clocks, loop_usecs); } break; /* LSDR is more like XSDRTDO than it is like XSDR. It uses LDELAY which * comes with clocks !AND! sleep requirements. */ case LSDR: { int limit = loop_count; int matched = 0; int attempt; 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 ) { do_abort = 1; break; } if (limit < 1) limit = 1; for( attempt=0; attempt<limit; ++attempt ) { scan_field_t field; xsvf_add_statemove( loop_state ); jtag_add_clocks(loop_clocks); jtag_add_sleep(loop_usecs); field.tap = tap; field.num_bits = xsdrsize; field.out_value = dr_out_buf; field.out_mask = NULL; field.in_value = NULL; if (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); else jtag_add_dr_scan(1, &field, TAP_DRPAUSE); /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); if(result == ERROR_OK) { matched = 1; break; } } if (!matched ) { LOG_USER( "LSDR mismatch" ); tdo_mismatch = 1; break; } } break; case XTRST: { u8 trst_mode; if (read(xsvf_fd, &trst_mode, 1) < 0) { do_abort = 1; break; } switch( trst_mode ) { case XTRST_ON: jtag_add_reset(1, 0); break; case XTRST_OFF: case XTRST_Z: jtag_add_reset(0, 0); break; case XTRST_ABSENT: break; default: LOG_ERROR( "XTRST mode argument (0x%02X) out of range", trst_mode ); do_abort = 1; } } break; default: LOG_ERROR("unknown xsvf command (0x%02X)\n", uc); unsupported = 1; } if (do_abort || unsupported || tdo_mismatch) { LOG_DEBUG("xsvf failed, setting taps to reasonable state"); /* upon error, return the TAPs to a reasonable state */ xsvf_add_statemove( TAP_IDLE ); jtag_execute_queue(); break; } } if (tdo_mismatch) { command_print(cmd_ctx, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting", file_offset ); return ERROR_FAIL; } if (unsupported) { command_print(cmd_ctx, "unsupported xsvf command: 0x%02X in xsvf file at offset %ld, aborting", uc, lseek(xsvf_fd, 0, SEEK_CUR)-1 ); return ERROR_FAIL; } if (do_abort) { command_print(cmd_ctx, "premature end of xsvf file detected, aborting"); return ERROR_FAIL; } if (dr_out_buf) free(dr_out_buf); if (dr_in_buf) free(dr_in_buf); if (dr_in_mask) free(dr_in_mask); close(xsvf_fd); command_print(cmd_ctx, "XSVF file programmed successfully"); return ERROR_OK; }