svf: Only read TDO back from the device if we actually need to look at the bits.
[openocd.git] / src / svf / svf.c
index 89ea80dc94dfd024c08676275ca0ba31ba48466d..0d37c8ff59dc819c78c840f213f6c6b60f7dcf3d 100644 (file)
@@ -241,6 +241,61 @@ static long svf_total_lines;
 static int svf_percentage;
 static int svf_last_printed_percentage = -1;
 
+/*
+ * macro is used to print the svf hex buffer at desired debug level
+ * DEBUG, INFO, ERROR, USER
+ */
+#define SVF_BUF_LOG(_lvl, _buf, _nbits, _desc)                                                 \
+       svf_hexbuf_print(LOG_LVL_##_lvl ,  __FILE__, __LINE__, __func__, _buf, _nbits, _desc)
+
+static void svf_hexbuf_print(int dbg_lvl, const char *file, unsigned line,
+                                                        const char *function, const uint8_t *buf,
+                                                        int bit_len, const char *desc)
+{
+       int j, len = 0;
+       int byte_len = DIV_ROUND_UP(bit_len, 8);
+       int msbits = bit_len % 8;
+
+       /* allocate 2 bytes per hex digit */
+       char *prbuf = malloc((byte_len * 2) + 1);
+       if (!prbuf)
+               return;
+
+       /* print correct number of bytes, mask excess bits where applicable */
+       uint8_t msb = buf[byte_len - 1] & (msbits ? (1 << msbits) - 1 : 0xff);
+       len = sprintf(prbuf, msbits <= 4 ? "0x%01"PRIx8 : "0x%02"PRIx8, msb);
+       for (j = byte_len - 2; j >= 0; j--)
+               len += sprintf(prbuf + len, "%02"PRIx8, buf[j]);
+
+       log_printf_lf(dbg_lvl, file, line, function, "%8s = %s", desc ? desc : " ", prbuf);
+
+       free(prbuf);
+}
+
+static int svf_realloc_buffers(size_t len)
+{
+       void *ptr;
+
+       ptr = realloc(svf_tdi_buffer, len);
+       if (!ptr)
+               return ERROR_FAIL;
+       svf_tdi_buffer = ptr;
+
+       ptr = realloc(svf_tdo_buffer, len);
+       if (!ptr)
+               return ERROR_FAIL;
+       svf_tdo_buffer = ptr;
+
+       ptr = realloc(svf_mask_buffer, len);
+       if (!ptr)
+               return ERROR_FAIL;
+       svf_mask_buffer = ptr;
+
+       svf_buffer_size = len;
+
+       return ERROR_OK;
+}
+
 static void svf_free_xxd_para(struct svf_xxr_para *para)
 {
        if (NULL != para) {
@@ -263,20 +318,6 @@ static void svf_free_xxd_para(struct svf_xxr_para *para)
        }
 }
 
-static unsigned svf_get_mask_u32(int bitlen)
-{
-       uint32_t bitmask;
-
-       if (bitlen < 0)
-               bitmask = 0;
-       else if (bitlen >= 32)
-               bitmask = 0xFFFFFFFF;
-       else
-               bitmask = (1 << bitlen) - 1;
-
-       return bitmask;
-}
-
 int svf_add_statemove(tap_state_t state_to)
 {
        tap_state_t state_from = cmd_queue_cur_state;
@@ -383,25 +424,10 @@ COMMAND_HANDLER(handle_svf_command)
        /* in case current command cannot be committed, and next command is a bit scan command */
        /* here is 32K bits for this big scan command, it should be enough */
        /* buffer will be reallocated if buffer size is not enough */
-       svf_tdi_buffer = malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
-       if (NULL == svf_tdi_buffer) {
-               LOG_ERROR("not enough memory");
-               ret = ERROR_FAIL;
-               goto free_all;
-       }
-       svf_tdo_buffer = malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
-       if (NULL == svf_tdo_buffer) {
-               LOG_ERROR("not enough memory");
+       if (svf_realloc_buffers(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT) != ERROR_OK) {
                ret = ERROR_FAIL;
                goto free_all;
        }
-       svf_mask_buffer = malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
-       if (NULL == svf_mask_buffer) {
-               LOG_ERROR("not enough memory");
-               ret = ERROR_FAIL;
-               goto free_all;
-       }
-       svf_buffer_size = 2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT;
 
        memcpy(&svf_para, &svf_para_init, sizeof(svf_para));
 
@@ -829,19 +855,11 @@ static int svf_check_tdo(void)
                if ((svf_check_tdo_para[i].enabled)
                                && buf_cmp_mask(&svf_tdi_buffer[index_var], &svf_tdo_buffer[index_var],
                                &svf_mask_buffer[index_var], len)) {
-                       unsigned bitmask;
-                       unsigned received, expected, tapmask;
-                       bitmask = svf_get_mask_u32(svf_check_tdo_para[i].bit_len);
-
-                       memcpy(&received, svf_tdi_buffer + index_var, sizeof(unsigned));
-                       memcpy(&expected, svf_tdo_buffer + index_var, sizeof(unsigned));
-                       memcpy(&tapmask, svf_mask_buffer + index_var, sizeof(unsigned));
                        LOG_ERROR("tdo check error at line %d",
                                svf_check_tdo_para[i].line_num);
-                       LOG_ERROR("read = 0x%X, want = 0x%X, mask = 0x%X",
-                               received & bitmask,
-                               expected & bitmask,
-                               tapmask & bitmask);
+                       SVF_BUF_LOG(ERROR, &svf_tdi_buffer[index_var], len, "READ");
+                       SVF_BUF_LOG(ERROR, &svf_tdo_buffer[index_var], len, "WANT");
+                       SVF_BUF_LOG(ERROR, &svf_mask_buffer[index_var], len, "MASK");
                        return ERROR_FAIL;
                }
        }
@@ -1036,8 +1054,7 @@ XXR_common:
                                        LOG_ERROR("fail to parse hex value");
                                        return ERROR_FAIL;
                                }
-                               LOG_DEBUG("\t%s = 0x%X", argus[i],
-                                               (**(int **)pbuffer_tmp) & svf_get_mask_u32(xxr_para_tmp->len));
+                               SVF_BUF_LOG(DEBUG, *pbuffer_tmp, xxr_para_tmp->len, argus[i]);
                        }
                        /* If a command changes the length of the last scan of the same type and the
                         * MASK parameter is absent, */
@@ -1078,47 +1095,11 @@ XXR_common:
                                i = svf_para.hdr_para.len + svf_para.sdr_para.len +
                                                svf_para.tdr_para.len;
                                if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3)) {
-#if 1
-                                       /* simply print error message */
-                                       LOG_ERROR("buffer is not enough, report to author");
-                                       return ERROR_FAIL;
-#else
-                                       uint8_t *buffer_tmp;
-
                                        /* reallocate buffer */
-                                       buffer_tmp = malloc(svf_buffer_index + ((i + 7) >> 3));
-                                       if (NULL == buffer_tmp) {
+                                       if (svf_realloc_buffers(svf_buffer_index + ((i + 7) >> 3)) != ERROR_OK) {
                                                LOG_ERROR("not enough memory");
                                                return ERROR_FAIL;
                                        }
-                                       memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
-                                       /* svf_tdi_buffer isn't NULL here */
-                                       free(svf_tdi_buffer);
-                                       svf_tdi_buffer = buffer_tmp;
-
-                                       buffer_tmp = malloc(svf_buffer_index + ((i + 7) >> 3));
-                                       if (NULL == buffer_tmp) {
-                                               LOG_ERROR("not enough memory");
-                                               return ERROR_FAIL;
-                                       }
-                                       memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
-                                       /* svf_tdo_buffer isn't NULL here */
-                                       free(svf_tdo_buffer);
-                                       svf_tdo_buffer = buffer_tmp;
-
-                                       buffer_tmp = malloc(svf_buffer_index + ((i + 7) >> 3));
-                                       if (NULL == buffer_tmp) {
-                                               LOG_ERROR("not enough memory");
-                                               return ERROR_FAIL;
-                                       }
-                                       memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
-                                       /* svf_mask_buffer isn't NULL here */
-                                       free(svf_mask_buffer);
-                                       svf_mask_buffer = buffer_tmp;
-
-                                       buffer_tmp = NULL;
-                                       svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
-#endif
                                }
 
                                /* assemble dr data */
@@ -1190,7 +1171,7 @@ XXR_common:
                                        svf_add_check_para(0, svf_buffer_index, i);
                                field.num_bits = i;
                                field.out_value = &svf_tdi_buffer[svf_buffer_index];
-                               field.in_value = &svf_tdi_buffer[svf_buffer_index];
+                               field.in_value = (xxr_para_tmp->data_mask & XXR_TDO) ? &svf_tdi_buffer[svf_buffer_index] : NULL;
                                if (!svf_nil) {
                                        /* NOTE:  doesn't use SVF-specified state paths */
                                        jtag_add_plain_dr_scan(field.num_bits,
@@ -1205,47 +1186,10 @@ XXR_common:
                                i = svf_para.hir_para.len + svf_para.sir_para.len +
                                                svf_para.tir_para.len;
                                if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3)) {
-#if 1
-                                       /* simply print error message */
-                                       LOG_ERROR("buffer is not enough, report to author");
-                                       return ERROR_FAIL;
-#else
-                                       uint8_t *buffer_tmp;
-
-                                       /* reallocate buffer */
-                                       buffer_tmp = malloc(svf_buffer_index + ((i + 7) >> 3));
-                                       if (NULL == buffer_tmp) {
-                                               LOG_ERROR("not enough memory");
-                                               return ERROR_FAIL;
-                                       }
-                                       memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
-                                       /* svf_tdi_buffer isn't NULL here */
-                                       free(svf_tdi_buffer);
-                                       svf_tdi_buffer = buffer_tmp;
-
-                                       buffer_tmp = malloc(svf_buffer_index + ((i + 7) >> 3));
-                                       if (NULL == buffer_tmp) {
-                                               LOG_ERROR("not enough memory");
-                                               return ERROR_FAIL;
-                                       }
-                                       memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
-                                       /* svf_tdo_buffer isn't NULL here */
-                                       free(svf_tdo_buffer);
-                                       svf_tdo_buffer = buffer_tmp;
-
-                                       buffer_tmp = malloc(svf_buffer_index + ((i + 7) >> 3));
-                                       if (NULL == buffer_tmp) {
+                                       if (svf_realloc_buffers(svf_buffer_index + ((i + 7) >> 3)) != ERROR_OK) {
                                                LOG_ERROR("not enough memory");
                                                return ERROR_FAIL;
                                        }
-                                       memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
-                                       /* svf_mask_buffer isn't NULL here */
-                                       free(svf_mask_buffer);
-                                       svf_mask_buffer = buffer_tmp;
-
-                                       buffer_tmp = NULL;
-                                       svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
-#endif
                                }
 
                                /* assemble ir data */
@@ -1317,7 +1261,7 @@ XXR_common:
                                        svf_add_check_para(0, svf_buffer_index, i);
                                field.num_bits = i;
                                field.out_value = &svf_tdi_buffer[svf_buffer_index];
-                               field.in_value = &svf_tdi_buffer[svf_buffer_index];
+                               field.in_value = (xxr_para_tmp->data_mask & XXR_TDO) ? &svf_tdi_buffer[svf_buffer_index] : NULL;
                                if (!svf_nil) {
                                        /* NOTE:  doesn't use SVF-specified state paths */
                                        jtag_add_plain_ir_scan(field.num_bits,
@@ -1573,11 +1517,7 @@ XXR_common:
 
                        /* output debug info */
                        if ((SIR == command) || (SDR == command)) {
-                               int read_value;
-                               memcpy(&read_value, svf_tdi_buffer, sizeof(int));
-                               /* in debug mode, data is from index 0 */
-                               int read_mask = svf_get_mask_u32(svf_check_tdo_para[0].bit_len);
-                               LOG_DEBUG("\tTDO read = 0x%X", read_value & read_mask);
+                               SVF_BUF_LOG(DEBUG, svf_tdi_buffer, svf_check_tdo_para[0].bit_len, "TDO read");
                        }
                }
        } else {

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)