* oyvind.harboe@zylin.com *
* *
* Copyright (C) 2009 SoftPLC Corporation *
- * http://softplc.com *
+ * http://softplc.com *
* dick@softplc.com *
* *
* This program is free software; you can redistribute it and/or modify *
#include "config.h"
#endif
+#define INCLUDE_JTAG_MINIDRIVER_H
+#define INCLUDE_JTAG_INTERFACE_H
#include "jtag.h"
#ifdef HAVE_STRINGS_H
int jtag_flush_queue_count; /* count # of flushes for profiling / debugging purposes */
-static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, scan_field_t *in_fields, tap_state_t state),
+static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
int in_num_fields, scan_field_t *in_fields, tap_state_t state);
/* note that this is not marked as static as it must be available from outside jtag.c for those
int jtag_trst = 0;
int jtag_srst = 0;
-#ifndef HAVE_JTAG_MINIDRIVER_H
-struct jtag_callback_entry
-{
- struct jtag_callback_entry *next;
-
- jtag_callback_t callback;
- u8 *in;
- jtag_callback_data_t data1;
- jtag_callback_data_t data2;
- jtag_callback_data_t data3;
-};
-
-
-static struct jtag_callback_entry *jtag_callback_queue_head = NULL;
-static struct jtag_callback_entry *jtag_callback_queue_tail = NULL;
-#endif
-
-
jtag_command_t *jtag_command_queue = NULL;
-jtag_command_t **last_command_pointer = &jtag_command_queue;
+static jtag_command_t **next_command_pointer = &jtag_command_queue;
static jtag_tap_t *jtag_all_taps = NULL;
enum reset_types jtag_reset_config = RESET_NONE;
NULL,
};
-jtag_interface_t *jtag = NULL;
+struct jtag_interface_s *jtag = NULL;
/* configuration */
static jtag_interface_t *jtag_interface = NULL;
return ERROR_OK;
}
-/* returns a pointer to the pointer of the last command in queue
- * this may be a pointer to the root pointer (jtag_command_queue)
- * or to the next member of the last but one command
- */
-jtag_command_t** jtag_get_last_command_p(void)
-{
-/* jtag_command_t *cmd = jtag_command_queue;
-
- if (cmd)
- while (cmd->next)
- cmd = cmd->next;
- else
- return &jtag_command_queue;
-
- return &cmd->next;*/
-
- return last_command_pointer;
-}
-
-
void jtag_queue_command(jtag_command_t * cmd)
{
- jtag_command_t **last_cmd;
-
- last_cmd = jtag_get_last_command_p();
+ // this command goes on the end, so ensure the queue terminates
+ cmd->next = NULL;
+ jtag_command_t **last_cmd = next_command_pointer;
+ assert(NULL != last_cmd);
+ assert(NULL == *last_cmd);
*last_cmd = cmd;
- (*last_cmd)->next = NULL;
-
- last_command_pointer = &((*last_cmd)->next);
+ // store location where the next command pointer will be stored
+ next_command_pointer = &cmd->next;
}
-
void* cmd_queue_alloc(size_t size)
{
cmd_queue_page_t **p_page = &cmd_queue_pages;
cmd_queue_pages = NULL;
}
+void jtag_command_queue_reset(void)
+{
+ cmd_queue_free();
+
+ jtag_command_queue = NULL;
+ next_command_pointer = &jtag_command_queue;
+}
+
static void jtag_prelude1(void)
{
if (jtag_trst == 1)
cmd_queue_cur_state = cmd_queue_end_state;
}
-void jtag_add_ir_scan_noverify(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
+void jtag_add_ir_scan_noverify(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
{
int retval;
jtag_prelude(state);
}
+/**
+ * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
+ *
+ * If the input field list contains an instruction value for a TAP then that is used
+ * otherwise the TAP is set to bypass.
+ *
+ * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
+ *
+ */
void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
{
if (jtag_verify&&jtag_verify_capture_ir)
{
- /* 8 x 32 bit id's is enough for all invoations */
+ /* 8 x 32 bit id's is enough for all invocations */
for (int j = 0; j < in_num_fields; j++)
{
- in_fields[j].check_value=NULL;
- in_fields[j].check_mask=NULL;
/* if we are to run a verification of the ir scan, we need to get the input back.
* We may have to allocate space if the caller didn't ask for the input back.
*/
}
/**
- * Generate a list of scan fields with one entry for each TAP.
+ * Duplicate the scan fields passed into the function into an IR SCAN command
*
- * If the input field list contains an instruction value for a TAP then that is used
- * otherwise the TAP is set to bypass.
+ * This function assumes that the caller handles extra fields for bypassed TAPs
*
*/
-int MINIDRIVER(interface_jtag_add_ir_scan)(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
-{
- jtag_tap_t *tap;
- int nth_tap;
-
- int num_taps = jtag_NumEnabledTaps();
-
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
- scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_SCAN;
- cmd->cmd.scan = scan;
-
- scan->ir_scan = true;
- scan->num_fields = num_taps; /* one field per device */
- scan->fields = cmd_queue_alloc(num_taps * sizeof(scan_field_t));
- scan->end_state = state;
-
- nth_tap = -1;
- tap = NULL;
- for(;;){
- int found = 0;
-
- /* do this here so it is not forgotten */
- tap = jtag_NextEnabledTap(tap);
- if( tap == NULL ){
- break;
- }
- nth_tap++;
-
- assert(nth_tap < num_taps);
-
- size_t scan_size = tap->ir_length;
- scan->fields[nth_tap].tap = tap;
- scan->fields[nth_tap].num_bits = scan_size;
- scan->fields[nth_tap].in_value = NULL; /* do not collect input for tap's in bypass */
-
- /* search the list */
- for (int j = 0; j < in_num_fields; j++)
- {
- if (tap == in_fields[j].tap)
- {
- found = 1;
- scan->fields[nth_tap].in_value = in_fields[j].in_value;
- scan->fields[nth_tap].out_value = buf_cpy(in_fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
-
- tap->bypass = 0;
- break;
- }
- }
-
- if (!found)
- {
- /* if a tap isn't listed, set it to BYPASS */
- scan->fields[nth_tap].out_value = buf_set_ones(cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
- tap->bypass = 1;
- }
-
- /* update device information */
- buf_cpy(scan->fields[nth_tap].out_value, tap->cur_instr, scan_size);
- }
-
- assert(nth_tap == (num_taps - 1));
-
- return ERROR_OK;
-}
-
-void jtag_add_plain_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
+void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
{
int retval;
jtag_error=retval;
}
-int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
-{
- /* allocate memory for a new list member */
-
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
- cmd->type = JTAG_SCAN;
- /* allocate memory for ir scan command */
- cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
- cmd->cmd.scan->ir_scan = true;
- cmd->cmd.scan->num_fields = in_num_fields;
- cmd->cmd.scan->fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
- cmd->cmd.scan->end_state = state;
-
- for (int i = 0; i < in_num_fields; i++)
- {
- int num_bits = in_fields[i].num_bits;
- int num_bytes = CEIL(in_fields[i].num_bits, 8);
- cmd->cmd.scan->fields[i].tap = in_fields[i].tap;
- cmd->cmd.scan->fields[i].num_bits = num_bits;
- cmd->cmd.scan->fields[i].out_value = buf_cpy(in_fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
- cmd->cmd.scan->fields[i].in_value = in_fields[i].in_value;
- }
+int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
- return ERROR_OK;
+static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
+{
+ return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
}
-void jtag_add_dr_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
+#ifdef HAVE_JTAG_MINIDRIVER_H
+void interface_jtag_add_scan_check_alloc(scan_field_t *field)
{
- int retval;
-
- jtag_prelude(state);
-
- retval=interface_jtag_add_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
- if (retval!=ERROR_OK)
- jtag_error=retval;
+ /* We're executing this synchronously, so try to use local storage. */
+ if (field->num_bits > 32)
+ {
+ unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
+ field->in_value = (u8 *)malloc(num_bytes);
+ field->allocated = 1;
+ }
+ else
+ field->in_value = field->intmp;
}
-
-
-int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
-
-static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
+#else
+void interface_jtag_add_scan_check_alloc(scan_field_t *field)
{
- return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
+ unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
+ field->in_value = (u8 *)cmd_queue_alloc(num_bytes);
}
+#endif
-static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, scan_field_t *in_fields, tap_state_t state),
+static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
int in_num_fields, scan_field_t *in_fields, tap_state_t state)
{
for (int i = 0; i < in_num_fields; i++)
{
- in_fields[i].allocated = 0;
- in_fields[i].modified = 0;
- if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value == NULL))
- {
- in_fields[i].modified = 1;
- /* we need storage space... */
-#ifdef HAVE_JTAG_MINIDRIVER_H
- if (in_fields[i].num_bits <= 32)
- {
- /* This is enough space and we're executing this synchronously */
- in_fields[i].in_value = in_fields[i].intmp;
- } else
- {
- in_fields[i].in_value = (u8 *)malloc(CEIL(in_fields[i].num_bits, 8));
- in_fields[i].allocated = 1;
- }
-#else
- in_fields[i].in_value = (u8 *)cmd_queue_alloc(CEIL(in_fields[i].num_bits, 8));
-#endif
- }
+ struct scan_field_s *field = &in_fields[i];
+ field->allocated = 0;
+ field->modified = 0;
+ if (field->check_value || field->in_value)
+ continue;
+ interface_jtag_add_scan_check_alloc(field);
+ field->modified = 1;
}
jtag_add_scan(in_num_fields, in_fields, state);
}
}
-int MINIDRIVER(interface_jtag_add_dr_scan)(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
-{
- int j;
- int nth_tap;
- int bypass_devices = 0;
- int field_count = 0;
- int scan_size;
-
- jtag_tap_t *tap;
-
- /* count devices in bypass */
- tap = NULL;
- bypass_devices = 0;
- for(;;){
- tap = jtag_NextEnabledTap(tap);
- if( tap == NULL ){
- break;
- }
- if( tap->bypass ){
- bypass_devices++;
- }
- }
-
- /* allocate memory for a new list member */
-
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_SCAN;
-
- /* allocate memory for dr scan command */
- cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
- cmd->cmd.scan->ir_scan = false;
- cmd->cmd.scan->num_fields = in_num_fields + bypass_devices;
- cmd->cmd.scan->fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
- cmd->cmd.scan->end_state = state;
-
- tap = NULL;
- nth_tap = -1;
- for(;;){
- nth_tap++;
- tap = jtag_NextEnabledTap(tap);
- if( tap == NULL ){
- break;
- }
- int found = 0;
- cmd->cmd.scan->fields[field_count].tap = tap;
-
- for (j = 0; j < in_num_fields; j++)
- {
- if (tap == in_fields[j].tap)
- {
- found = 1;
- scan_size = in_fields[j].num_bits;
- cmd->cmd.scan->fields[field_count].num_bits = scan_size;
- cmd->cmd.scan->fields[field_count].out_value = buf_cpy(in_fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
- cmd->cmd.scan->fields[field_count].in_value = in_fields[j].in_value;
- field_count++;
- }
- }
- if (!found)
- {
-#ifdef _DEBUG_JTAG_IO_
- /* if a device isn't listed, the BYPASS register should be selected */
- if (! tap->bypass)
- {
- LOG_ERROR("BUG: no scan data for a device not in BYPASS");
- exit(-1);
- }
-#endif
- /* program the scan field to 1 bit length, and ignore it's value */
- cmd->cmd.scan->fields[field_count].num_bits = 1;
- cmd->cmd.scan->fields[field_count].out_value = NULL;
- cmd->cmd.scan->fields[field_count].in_value = NULL;
- field_count++;
- }
- else
- {
-#ifdef _DEBUG_JTAG_IO_
- /* if a device is listed, the BYPASS register must not be selected */
- if (tap->bypass)
- {
- LOG_ERROR("BUG: scan data for a device in BYPASS");
- exit(-1);
- }
-#endif
- }
- }
-
- /* field_count represents the true number of fields setup*/
- cmd->cmd.scan->num_fields = field_count;
- return ERROR_OK;
-}
-void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
- int in_num_fields,
- const int *num_bits,
- const u32 *value,
- tap_state_t end_state)
+/**
+ * Generate a DR SCAN using the fields passed to the function
+ *
+ * For not bypassed TAPs the function checks in_fields and uses fields specified there.
+ * For bypassed TAPs the function generates a dummy 1bit field.
+ *
+ * The bypass status of TAPs is set by jtag_add_ir_scan().
+ *
+ */
+void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
{
- int nth_tap;
- int field_count = 0;
- int scan_size;
- int bypass_devices = 0;
-
- jtag_tap_t *tap;
-
- /* count devices in bypass */
- tap = NULL;
- bypass_devices = 0;
- for(;;){
- tap = jtag_NextEnabledTap(tap);
- if( tap == NULL ){
- break;
- }
- if( tap->bypass ){
- bypass_devices++;
- }
- }
-
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
+ int retval;
- cmd->type = JTAG_SCAN;
+ jtag_prelude(state);
- /* allocate memory for dr scan command */
- cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
- cmd->cmd.scan->ir_scan = false;
- cmd->cmd.scan->num_fields = in_num_fields + bypass_devices;
- cmd->cmd.scan->fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
- cmd->cmd.scan->end_state = end_state;
+ retval=interface_jtag_add_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
+ if (retval!=ERROR_OK)
+ jtag_error=retval;
+}
- tap = NULL;
- nth_tap = -1;
- for(;;){
- tap = jtag_NextEnabledTap(tap);
- if( tap == NULL ){
- break;
- }
- nth_tap++;
- cmd->cmd.scan->fields[field_count].tap = tap;
- if (tap == target_tap)
- {
- int j;
-#ifdef _DEBUG_JTAG_IO_
- /* if a device is listed, the BYPASS register must not be selected */
- if (tap->bypass)
- {
- LOG_ERROR("BUG: scan data for a device in BYPASS");
- exit(-1);
- }
-#endif
- for (j = 0; j < in_num_fields; j++)
- {
- u8 out_value[4];
- scan_size = num_bits[j];
- buf_set_u32(out_value, 0, scan_size, value[j]);
- cmd->cmd.scan->fields[field_count].num_bits = scan_size;
- cmd->cmd.scan->fields[field_count].out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
- cmd->cmd.scan->fields[field_count].in_value = NULL;
- field_count++;
- }
- } else
- {
-#ifdef _DEBUG_JTAG_IO_
- /* if a device isn't listed, the BYPASS register should be selected */
- if (! tap->bypass)
- {
- LOG_ERROR("BUG: no scan data for a device not in BYPASS");
- exit(-1);
- }
-#endif
- /* program the scan field to 1 bit length, and ignore it's value */
- cmd->cmd.scan->fields[field_count].num_bits = 1;
- cmd->cmd.scan->fields[field_count].out_value = NULL;
- cmd->cmd.scan->fields[field_count].in_value = NULL;
- field_count++;
- }
- }
-}
-void jtag_add_plain_dr_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
+/**
+ * Duplicate the scan fields passed into the function into a DR SCAN command
+ *
+ * This function assumes that the caller handles extra fields for bypassed TAPs
+ *
+ */
+void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
{
int retval;
jtag_error=retval;
}
-int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
-{
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_SCAN;
- /* allocate memory for scan command */
- cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
- cmd->cmd.scan->ir_scan = false;
- cmd->cmd.scan->num_fields = in_num_fields;
- cmd->cmd.scan->fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
- cmd->cmd.scan->end_state = state;
-
- for (int i = 0; i < in_num_fields; i++)
- {
- int num_bits = in_fields[i].num_bits;
- int num_bytes = CEIL(in_fields[i].num_bits, 8);
- cmd->cmd.scan->fields[i].tap = in_fields[i].tap;
- cmd->cmd.scan->fields[i].num_bits = num_bits;
- cmd->cmd.scan->fields[i].out_value = buf_cpy(in_fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
- cmd->cmd.scan->fields[i].in_value = in_fields[i].in_value;
- }
-
- return ERROR_OK;
-}
void jtag_add_tlr(void)
{
jtag_error=retval;
}
-int MINIDRIVER(interface_jtag_add_tlr)(void)
-{
- tap_state_t state = TAP_RESET;
-
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_STATEMOVE;
-
- cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
- cmd->cmd.statemove->end_state = state;
-
- return ERROR_OK;
-}
-
-void jtag_add_pathmove(int num_states, tap_state_t *path)
+void jtag_add_pathmove(int num_states, const tap_state_t *path)
{
tap_state_t cur_state = cmd_queue_cur_state;
int i;
jtag_error=retval;
}
-int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, tap_state_t *path)
-{
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_PATHMOVE;
-
- cmd->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
- cmd->cmd.pathmove->num_states = num_states;
- cmd->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
-
- for (int i = 0; i < num_states; i++)
- cmd->cmd.pathmove->path[i] = path[i];
-
- return ERROR_OK;
-}
-
-int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
-{
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_RUNTEST;
-
- cmd->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
- cmd->cmd.runtest->num_cycles = num_cycles;
- cmd->cmd.runtest->end_state = state;
-
- return ERROR_OK;
-}
-
void jtag_add_runtest(int num_cycles, tap_state_t state)
{
int retval;
}
-int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
-{
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_STABLECLOCKS;
-
- cmd->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
- cmd->cmd.stableclocks->num_cycles = num_cycles;
-
- return ERROR_OK;
-}
-
void jtag_add_clocks( int num_cycles )
{
int retval;
jtag_error=retval;
return;
}
+ jtag_execute_queue();
if (jtag_srst)
{
* and inform possible listeners about this
*/
LOG_DEBUG("TRST line asserted");
- cmd_queue_cur_state = TAP_RESET;
+ tap_set_state(TAP_RESET);
jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
}
else
}
}
-int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
-{
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_RESET;
-
- cmd->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
- cmd->cmd.reset->trst = req_trst;
- cmd->cmd.reset->srst = req_srst;
-
- return ERROR_OK;
-}
-
void jtag_add_end_state(tap_state_t state)
{
cmd_queue_end_state = state;
}
}
-int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
-{
- /* allocate memory for a new list member */
- jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
-
- jtag_queue_command(cmd);
-
- cmd->type = JTAG_SLEEP;
-
- cmd->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
- cmd->cmd.sleep->us = us;
-
- return ERROR_OK;
-}
-
void jtag_add_sleep(u32 us)
{
keep_alive(); /* we might be running on a very slow JTAG clk */
return;
}
-int jtag_scan_size(scan_command_t *cmd)
+int jtag_scan_size(const scan_command_t *cmd)
{
int bit_count = 0;
int i;
return bit_count;
}
-int jtag_build_buffer(scan_command_t *cmd, u8 **buffer)
+int jtag_build_buffer(const scan_command_t *cmd, u8 **buffer)
{
int bit_count = 0;
int i;
return bit_count;
}
-int jtag_read_buffer(u8 *buffer, scan_command_t *cmd)
+int jtag_read_buffer(u8 *buffer, const scan_command_t *cmd)
{
int i;
int bit_count = 0;
return retval;
}
-static const char *jtag_tap_name(jtag_tap_t *tap)
+static const char *jtag_tap_name(const jtag_tap_t *tap)
{
return (tap == NULL) ? "(unknown)" : tap->dotted_name;
}
-enum scan_type jtag_scan_type(scan_command_t *cmd)
+enum scan_type jtag_scan_type(const scan_command_t *cmd)
{
int i;
int type = 0;
return type;
}
-
-#ifndef HAVE_JTAG_MINIDRIVER_H
-/* add callback to end of queue */
-void jtag_add_callback4(jtag_callback_t callback, u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
-{
- struct jtag_callback_entry *entry=cmd_queue_alloc(sizeof(struct jtag_callback_entry));
-
- entry->next=NULL;
- entry->callback=callback;
- entry->in=in;
- entry->data1=data1;
- entry->data2=data2;
- entry->data3=data3;
-
- if (jtag_callback_queue_head==NULL)
- {
- jtag_callback_queue_head=entry;
- jtag_callback_queue_tail=entry;
- } else
- {
- jtag_callback_queue_tail->next=entry;
- jtag_callback_queue_tail=entry;
- }
-}
-
-
-static int jtag_convert_to_callback4(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
+int default_interface_jtag_execute_queue(void)
{
- ((jtag_callback1_t)data1)(in);
- return ERROR_OK;
-}
-
-void jtag_add_callback(jtag_callback1_t callback, u8 *in)
-{
- jtag_add_callback4(jtag_convert_to_callback4, in, (jtag_callback_data_t)callback, 0, 0);
-}
-#endif
-
-#ifndef HAVE_JTAG_MINIDRIVER_H
-
-int interface_jtag_execute_queue(void)
-{
- int retval;
-
- if (jtag==NULL)
+ if (NULL == jtag)
{
- LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
+ LOG_ERROR("No JTAG interface configured yet. "
+ "Issue 'init' command in startup scripts "
+ "before communicating with targets.");
return ERROR_FAIL;
}
- retval = jtag->execute_queue();
-
- if (retval == ERROR_OK)
- {
- struct jtag_callback_entry *entry;
- for (entry=jtag_callback_queue_head; entry!=NULL; entry=entry->next)
- {
- retval=entry->callback(entry->in, entry->data1, entry->data2, entry->data3);
- if (retval!=ERROR_OK)
- break;
- }
- }
-
- cmd_queue_free();
-
- jtag_callback_queue_head = NULL;
- jtag_callback_queue_tail = NULL;
-
- jtag_command_queue = NULL;
- last_command_pointer = &jtag_command_queue;
-
- return retval;
+ return jtag->execute_queue();
}
-#endif
void jtag_execute_queue_noclear(void)
{
register_command(cmd_ctx, NULL, "interface", handle_interface_command,
COMMAND_CONFIG, "try to configure interface");
register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
- COMMAND_ANY, "set jtag speed (if supported)");
+ COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
- COMMAND_ANY, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
+ COMMAND_ANY, "set maximum jtag speed (if supported); "
+ "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
- COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
+ COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
COMMAND_ANY,
"[none/trst_only/srst_only/trst_and_srst] [srst_pulls_trst/trst_pulls_srst] [combined/separate] [trst_push_pull/trst_open_drain] [srst_push_pull/srst_open_drain]");
return ERROR_OK;
}
+int jtag_interface_quit(void)
+{
+ if (!jtag || !jtag->quit)
+ return ERROR_OK;
+
+ // close the JTAG interface
+ int result = jtag->quit();
+ if (ERROR_OK != result)
+ LOG_ERROR("failed: %d", result);
+
+ return ERROR_OK;
+}
+
+
int jtag_init_reset(struct command_context_s *cmd_ctx)
{
int retval;
static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
+ int new_cfg = 0;
+ int mask = 0;
+
if (argc < 1)
return ERROR_COMMAND_SYNTAX_ERROR;
- if (argc >= 1)
- {
- if (strcmp(args[0], "none") == 0)
- jtag_reset_config = RESET_NONE;
- else if (strcmp(args[0], "trst_only") == 0)
- jtag_reset_config = RESET_HAS_TRST;
- else if (strcmp(args[0], "srst_only") == 0)
- jtag_reset_config = RESET_HAS_SRST;
- else if (strcmp(args[0], "trst_and_srst") == 0)
- jtag_reset_config = RESET_TRST_AND_SRST;
+ /* Original versions cared about the order of these tokens:
+ * reset_config signals [combination [trst_type [srst_type]]]
+ * They also clobbered the previous configuration even on error.
+ *
+ * Here we don't care about the order, and only change values
+ * which have been explicitly specified.
+ */
+ for (; argc; argc--, args++) {
+ int tmp = 0;
+ int m;
+
+ /* signals */
+ m = RESET_HAS_TRST | RESET_HAS_SRST;
+ if (strcmp(*args, "none") == 0)
+ tmp = RESET_NONE;
+ else if (strcmp(*args, "trst_only") == 0)
+ tmp = RESET_HAS_TRST;
+ else if (strcmp(*args, "srst_only") == 0)
+ tmp = RESET_HAS_SRST;
+ else if (strcmp(*args, "trst_and_srst") == 0)
+ tmp = RESET_HAS_TRST | RESET_HAS_SRST;
else
- {
- LOG_ERROR("(1) invalid reset_config argument (%s), defaulting to none", args[0]);
- jtag_reset_config = RESET_NONE;
+ m = 0;
+ if (mask & m) {
+ LOG_ERROR("extra reset_config %s spec (%s)",
+ "signal", *args);
return ERROR_INVALID_ARGUMENTS;
}
- }
-
- if (argc >= 2)
- {
- if (strcmp(args[1], "separate") == 0)
- {
- /* seperate reset lines - default */
- } else
- {
- if (strcmp(args[1], "srst_pulls_trst") == 0)
- jtag_reset_config |= RESET_SRST_PULLS_TRST;
- else if (strcmp(args[1], "trst_pulls_srst") == 0)
- jtag_reset_config |= RESET_TRST_PULLS_SRST;
- else if (strcmp(args[1], "combined") == 0)
- jtag_reset_config |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
- else
- {
- LOG_ERROR("(2) invalid reset_config argument (%s), defaulting to none", args[1]);
- jtag_reset_config = RESET_NONE;
- return ERROR_INVALID_ARGUMENTS;
- }
+ if (m)
+ goto next;
+
+ /* combination (options for broken wiring) */
+ m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
+ if (strcmp(*args, "separate") == 0)
+ /* separate reset lines - default */;
+ else if (strcmp(*args, "srst_pulls_trst") == 0)
+ tmp |= RESET_SRST_PULLS_TRST;
+ else if (strcmp(*args, "trst_pulls_srst") == 0)
+ tmp |= RESET_TRST_PULLS_SRST;
+ else if (strcmp(*args, "combined") == 0)
+ tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
+ else
+ m = 0;
+ if (mask & m) {
+ LOG_ERROR("extra reset_config %s spec (%s)",
+ "combination", *args);
+ return ERROR_INVALID_ARGUMENTS;
}
- }
+ if (m)
+ goto next;
- if (argc >= 3)
- {
- if (strcmp(args[2], "trst_open_drain") == 0)
- jtag_reset_config |= RESET_TRST_OPEN_DRAIN;
- else if (strcmp(args[2], "trst_push_pull") == 0)
- jtag_reset_config &= ~RESET_TRST_OPEN_DRAIN;
+ /* trst_type (NOP without HAS_TRST) */
+ m = RESET_TRST_OPEN_DRAIN;
+ if (strcmp(*args, "trst_open_drain") == 0)
+ tmp |= RESET_TRST_OPEN_DRAIN;
+ else if (strcmp(*args, "trst_push_pull") == 0)
+ /* push/pull from adapter - default */;
else
- {
- LOG_ERROR("(3) invalid reset_config argument (%s) defaulting to none", args[2] );
- jtag_reset_config = RESET_NONE;
+ m = 0;
+ if (mask & m) {
+ LOG_ERROR("extra reset_config %s spec (%s)",
+ "trst_type", *args);
return ERROR_INVALID_ARGUMENTS;
}
- }
+ if (m)
+ goto next;
- if (argc >= 4)
- {
- if (strcmp(args[3], "srst_push_pull") == 0)
- jtag_reset_config |= RESET_SRST_PUSH_PULL;
- else if (strcmp(args[3], "srst_open_drain") == 0)
- jtag_reset_config &= ~RESET_SRST_PUSH_PULL;
+ /* srst_type (NOP without HAS_SRST) */
+ m |= RESET_SRST_PUSH_PULL;
+ if (strcmp(*args, "srst_push_pull") == 0)
+ tmp |= RESET_SRST_PUSH_PULL;
+ else if (strcmp(*args, "srst_open_drain") == 0)
+ /* open drain from adapter - default */;
else
- {
- LOG_ERROR("(4) invalid reset_config argument (%s), defaulting to none", args[3]);
- jtag_reset_config = RESET_NONE;
+ m = 0;
+ if (mask & m) {
+ LOG_ERROR("extra reset_config %s spec (%s)",
+ "srst_type", *args);
return ERROR_INVALID_ARGUMENTS;
}
+ if (m)
+ goto next;
+
+ /* caller provided nonsense; fail */
+ LOG_ERROR("unknown reset_config flag (%s)", *args);
+ return ERROR_INVALID_ARGUMENTS;
+
+next:
+ /* Remember the bits which were specified (mask)
+ * and their new values (new_cfg).
+ */
+ mask |= m;
+ new_cfg |= tmp;
}
+ /* clear previous values of those bits, save new values */
+ jtag_reset_config &= ~mask;
+ jtag_reset_config |= new_cfg;
+
return ERROR_OK;
}
}
+/*
+ * For "irscan" or "drscan" commands, the "end" (really, "next") state
+ * should be stable ... and *NOT* a shift state, otherwise free-running
+ * jtag clocks could change the values latched by the update state.
+ */
+static bool scan_is_safe(tap_state_t state)
+{
+ switch (state)
+ {
+ case TAP_RESET:
+ case TAP_IDLE:
+ case TAP_DRPAUSE:
+ case TAP_IRPAUSE:
+ return true;
+ default:
+ return false;
+ }
+}
+
+
static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
int i;
return ERROR_COMMAND_SYNTAX_ERROR;
}
- /* optional "-endstate" */
- /* "statename" */
- /* at the end of the arguments. */
- /* assume none. */
- endstate = cmd_queue_end_state;
+ /* optional "-endstate" "statename" at the end of the arguments,
+ * so that e.g. IRPAUSE can let us load the data register before
+ * entering RUN/IDLE to execute the instruction we load here.
+ */
+ endstate = TAP_IDLE;
+
if( argc >= 4 ){
/* have at least one pair of numbers. */
/* is last pair the magic text? */
if( endstate >= TAP_NUM_STATES ){
return ERROR_COMMAND_SYNTAX_ERROR;
} else {
+ if (!scan_is_safe(endstate))
+ LOG_WARNING("irscan with unsafe "
+ "endstate \"%s\"", cpA);
/* found - remove the last 2 args */
argc -= 2;
}
return JIM_ERR;
}
- /* assume no endstate */
- endstate = cmd_queue_end_state;
+ endstate = TAP_IDLE;
+
/* validate arguments as numbers */
e = JIM_OK;
for (i = 2; i < argc; i+=2)
return e;
}
- /* it could be: "-endstate FOO" */
+ /* it could be: "-endstate FOO"
+ * e.g. DRPAUSE so we can issue more instructions
+ * before entering RUN/IDLE and executing them.
+ */
/* get arg as a string. */
cp = Jim_GetString( args[i], NULL );
/* update the error message */
Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
} else {
+ if (!scan_is_safe(endstate))
+ LOG_WARNING("drscan with unsafe "
+ "endstate \"%s\"", cp);
+
/* valid - so clear the error */
e = JIM_OK;
/* and remove the last 2 args */
* N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
* N.B. These values are tightly bound to the table in tap_get_tms_path_len().
* N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
- * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
+ * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
*/
static const struct tms_sequences short_tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
{
- /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
+ /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
OK, I added Peter's version of the state table, and it works OK for
me on MC1322x. I've recreated the jlink portion of patch with this
/* to state: */
/* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
- { B8(1111111,7), B8(0000000,7), B8(00101,5), B8(01010,5), B8(001101,6), B8(010110,6) }, /* RESET */
+ { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
{ B8(1111111,7), B8(0000000,7), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
- { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
- { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
+ { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
+ { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
{ B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
{ B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
{
bool is_stable;
- /* A switch() is used because it is symbol dependent
+ /* A switch() is used because it is symbol dependent
(not value dependent like an array), and can also check bounds.
*/
switch( astate )
{
tap_state_t new_state;
- /* A switch is used because it is symbol dependent and not value dependent
+ /* A switch is used because it is symbol dependent and not value dependent
like an array. Also it can check for out of range conditions.
*/
}
#endif // _DEBUG_JTAG_IO_
-#ifndef HAVE_JTAG_MINIDRIVER_H
-void jtag_alloc_in_value32(scan_field_t *field)
-{
- field->in_value=(u8 *)cmd_queue_alloc(4);
-}
-#endif
-
static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
if (argc == 1)
}
/*-----</Cable Helper API>--------------------------------------*/
+
+
+/**
+ * Function jtag_add_statemove
+ * moves from the current state to the goal \a state. This needs
+ * to be handled according to the xsvf spec, see the XSTATE command
+ * description.
+ */
+int jtag_add_statemove(tap_state_t goal_state)
+{
+ int retval = ERROR_OK;
+
+ tap_state_t moves[8];
+ tap_state_t cur_state = cmd_queue_cur_state;
+ int i;
+ int tms_bits;
+ int tms_count;
+
+ LOG_DEBUG( "cur_state=%s goal_state=%s",
+ tap_state_name(cur_state),
+ tap_state_name(goal_state) );
+
+
+ /* From the XSVF spec, pertaining to XSTATE:
+
+ 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.
+ */
+
+ if (goal_state==cur_state )
+ ; /* nothing to do */
+
+ else if( goal_state==TAP_RESET )
+ {
+ jtag_add_tlr();
+ }
+
+ else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
+ {
+ /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
+ spec, then this code is not fully conformant to the xsvf spec. This
+ puts a burden on tap_get_tms_path() function from the xsvf spec.
+ If in doubt, you should confirm that that burden is being met.
+ */
+
+ tms_bits = tap_get_tms_path(cur_state, goal_state);
+ tms_count = tap_get_tms_path_len(cur_state, goal_state);
+
+ assert( (unsigned) tms_count < DIM(moves) );
+
+ for (i=0; i<tms_count; i++, tms_bits>>=1)
+ {
+ bool bit = tms_bits & 1;
+
+ cur_state = tap_state_transition(cur_state, bit);
+ moves[i] = cur_state;
+ }
+
+ jtag_add_pathmove(tms_count, moves);
+ }
+
+ /* else state must be immediately reachable in one clock cycle, and does not
+ need to be a stable state.
+ */
+ else if( tap_state_transition(cur_state, true) == goal_state
+ || tap_state_transition(cur_state, false) == goal_state )
+ {
+ /* move a single state */
+ moves[0] = goal_state;
+ jtag_add_pathmove( 1, moves );
+ }
+
+ else
+ {
+ retval = ERROR_FAIL;
+ }
+
+ return retval;
+}
+