target/mips32_pracc: fix C99 format specifiers
[openocd.git] / src / target / mips32_pracc.c
index 64acc700be694f364ccdac2ef3042a07c40b1c37..e97626cb2eb702700935c32ba4740a8beacf33c4 100644 (file)
  * The original code contained NOPs. I have removed these and moved
  * the branches.
  *
- * I also moved the PRACC_STACK to 0xFF204000. This allows
- * the use of 16 bits offsets to get pointers to the input
- * and output area relative to the stack. Note that the stack
- * isn't really a stack (the stack pointer is not 'moving')
- * but a FIFO simulated in software.
- *
  * These changes result in a 35% speed increase when programming an
  * external flash.
  *
@@ -82,8 +76,6 @@
 #include "mips32_pracc.h"
 
 struct mips32_pracc_context {
-       uint32_t *local_iparam;
-       int num_iparam;
        uint32_t *local_oparam;
        int num_oparam;
        const uint32_t *code;
@@ -97,22 +89,20 @@ static int wait_for_pracc_rw(struct mips_ejtag *ejtag_info, uint32_t *ctrl)
 {
        uint32_t ejtag_ctrl;
        long long then = timeval_ms();
-       int timeout;
-       int retval;
 
        /* wait for the PrAcc to become "1" */
        mips_ejtag_set_instr(ejtag_info, EJTAG_INST_CONTROL);
 
        while (1) {
                ejtag_ctrl = ejtag_info->ejtag_ctrl;
-               retval = mips_ejtag_drscan_32(ejtag_info, &ejtag_ctrl);
+               int retval = mips_ejtag_drscan_32(ejtag_info, &ejtag_ctrl);
                if (retval != ERROR_OK)
                        return retval;
 
                if (ejtag_ctrl & EJTAG_CTRL_PRACC)
                        break;
 
-               timeout = timeval_ms() - then;
+               int timeout = timeval_ms() - then;
                if (timeout > 1000) {
                        LOG_DEBUG("DEBUGMODULE: No memory access in progress!");
                        return ERROR_JTAG_DEVICE_ERROR;
@@ -123,151 +113,212 @@ static int wait_for_pracc_rw(struct mips_ejtag *ejtag_info, uint32_t *ctrl)
        return ERROR_OK;
 }
 
-static int mips32_pracc_exec_read(struct mips32_pracc_context *ctx, uint32_t address)
+/* Shift in control and address for a new processor access, save them in ejtag_info */
+static int mips32_pracc_read_ctrl_addr(struct mips_ejtag *ejtag_info)
 {
-       struct mips_ejtag *ejtag_info = ctx->ejtag_info;
-       int offset;
-       uint32_t ejtag_ctrl, data;
-
-       if ((address >= MIPS32_PRACC_PARAM_IN)
-               && (address < MIPS32_PRACC_PARAM_IN + ctx->num_iparam * 4)) {
-               offset = (address - MIPS32_PRACC_PARAM_IN) / 4;
-               data = ctx->local_iparam[offset];
-       } else if ((address >= MIPS32_PRACC_PARAM_OUT)
-               && (address < MIPS32_PRACC_PARAM_OUT + ctx->num_oparam * 4)) {
-               offset = (address - MIPS32_PRACC_PARAM_OUT) / 4;
-               data = ctx->local_oparam[offset];
-       } else if ((address >= MIPS32_PRACC_TEXT)
-               && (address < MIPS32_PRACC_TEXT + ctx->code_len * 4)) {
-               offset = (address - MIPS32_PRACC_TEXT) / 4;
-               data = ctx->code[offset];
-       } else if (address == MIPS32_PRACC_STACK) {
-               if (ctx->stack_offset <= 0) {
-                       LOG_ERROR("Error: Pracc stack out of bounds");
-                       return ERROR_JTAG_DEVICE_ERROR;
-               }
-               /* save to our debug stack */
-               data = ctx->stack[--ctx->stack_offset];
-       } else if (address >= 0xFF200000) {
-               /* CPU keeps reading at the end of execution.
-                * If we after 0xF0000000  address range, we can use
-                * one shot jump instruction.
-                * Since this instruction is limited to
-                * 26bit, we need to do some magic to fit it to our needs. */
-               LOG_DEBUG("Reading unexpected address. Jump to 0xFF200200\n");
-               data = MIPS32_J((0x0FFFFFFF & 0xFF200200) >> 2);
-       } else {
-               LOG_ERROR("Error reading unexpected address 0x%8.8" PRIx32 "", address);
-               return ERROR_JTAG_DEVICE_ERROR;
-       }
+       int retval = wait_for_pracc_rw(ejtag_info, &ejtag_info->pa_ctrl);
+       if (retval != ERROR_OK)
+               return retval;
 
-       /* Send the data out */
-       mips_ejtag_set_instr(ctx->ejtag_info, EJTAG_INST_DATA);
-       mips_ejtag_drscan_32_out(ctx->ejtag_info, data);
+       mips_ejtag_set_instr(ejtag_info, EJTAG_INST_ADDRESS);
+       ejtag_info->pa_addr = 0;
+       retval = mips_ejtag_drscan_32(ejtag_info, &ejtag_info->pa_addr);
 
-       /* Clear the access pending bit (let the processor eat!) */
-       ejtag_ctrl = ejtag_info->ejtag_ctrl & ~EJTAG_CTRL_PRACC;
-       mips_ejtag_set_instr(ctx->ejtag_info, EJTAG_INST_CONTROL);
-       mips_ejtag_drscan_32_out(ctx->ejtag_info, ejtag_ctrl);
+       return retval;
+}
+
+/* Finish processor access */
+static int mips32_pracc_finish(struct mips_ejtag *ejtag_info)
+{
+       uint32_t ctrl = ejtag_info->ejtag_ctrl & ~EJTAG_CTRL_PRACC;
+       mips_ejtag_set_instr(ejtag_info, EJTAG_INST_CONTROL);
+       mips_ejtag_drscan_32_out(ejtag_info, ctrl);
 
        return jtag_execute_queue();
 }
 
-static int mips32_pracc_exec_write(struct mips32_pracc_context *ctx, uint32_t address)
+int mips32_pracc_clean_text_jump(struct mips_ejtag *ejtag_info)
 {
-       uint32_t ejtag_ctrl, data;
-       int offset;
-       struct mips_ejtag *ejtag_info = ctx->ejtag_info;
+       uint32_t jt_code = MIPS32_J((0x0FFFFFFF & MIPS32_PRACC_TEXT) >> 2);
        int retval;
 
-       mips_ejtag_set_instr(ctx->ejtag_info, EJTAG_INST_DATA);
-       retval = mips_ejtag_drscan_32(ctx->ejtag_info, &data);
-       if (retval != ERROR_OK)
-               return retval;
+       /* do 3 0/nops to clean pipeline before a jump to pracc text, NOP in delay slot */
+       for (int i = 0; i != 5; i++) {
+               /* Wait for pracc */
+               retval = wait_for_pracc_rw(ejtag_info, &ejtag_info->pa_ctrl);
+               if (retval != ERROR_OK)
+                       return retval;
 
-       /* Clear access pending bit */
-       ejtag_ctrl = ejtag_info->ejtag_ctrl & ~EJTAG_CTRL_PRACC;
-       mips_ejtag_set_instr(ctx->ejtag_info, EJTAG_INST_CONTROL);
-       mips_ejtag_drscan_32_out(ctx->ejtag_info, ejtag_ctrl);
+               /* Data or instruction out */
+               mips_ejtag_set_instr(ejtag_info, EJTAG_INST_DATA);
+               uint32_t data = (i == 3) ? jt_code : MIPS32_NOP;
+               mips_ejtag_drscan_32_out(ejtag_info, data);
 
-       retval = jtag_execute_queue();
+               /* finish pa */
+               retval = mips32_pracc_finish(ejtag_info);
+               if (retval != ERROR_OK)
+                       return retval;
+       }
+
+       if (ejtag_info->mode != 0)      /* done, queued mode won't work with lexra cores */
+               return ERROR_OK;
+
+       retval = mips32_pracc_read_ctrl_addr(ejtag_info);
        if (retval != ERROR_OK)
                return retval;
 
-       if ((address >= MIPS32_PRACC_PARAM_OUT)
-               && (address < MIPS32_PRACC_PARAM_OUT + ctx->num_oparam * 4)) {
-               offset = (address - MIPS32_PRACC_PARAM_OUT) / 4;
-               ctx->local_oparam[offset] = data;
-       } else if (address == MIPS32_PRACC_STACK) {
-               if (ctx->stack_offset >= 32) {
-                       LOG_ERROR("Error: Pracc stack out of bounds");
-                       return ERROR_JTAG_DEVICE_ERROR;
-               }
-               /* save data onto our stack */
-               ctx->stack[ctx->stack_offset++] = data;
-       } else {
-               LOG_ERROR("Error writing unexpected address 0x%8.8" PRIx32 "", address);
-               return ERROR_JTAG_DEVICE_ERROR;
+       if (ejtag_info->pa_addr != MIPS32_PRACC_TEXT) {                 /* LEXRA/BMIPS ?, shift out another NOP */
+               mips_ejtag_set_instr(ejtag_info, EJTAG_INST_DATA);
+               mips_ejtag_drscan_32_out(ejtag_info, MIPS32_NOP);
+               retval = mips32_pracc_finish(ejtag_info);
+               if (retval != ERROR_OK)
+                       return retval;
        }
 
        return ERROR_OK;
 }
 
-int mips32_pracc_exec(struct mips_ejtag *ejtag_info, int code_len, const uint32_t *code,
-               int num_param_in, uint32_t *param_in, int num_param_out, uint32_t *param_out, int cycle)
+int mips32_pracc_exec(struct mips_ejtag *ejtag_info, struct pracc_queue_info *ctx, uint32_t *param_out)
 {
-       uint32_t ejtag_ctrl;
-       uint32_t address;
-       struct mips32_pracc_context ctx;
+       int code_count = 0;
+       int store_pending = 0;          /* increases with every store instruction at dmseg, decreases with every store pa */
+       uint32_t max_store_addr = 0;    /* for store pa address testing */
+       bool restart = 0;               /* restarting control */
+       int restart_count = 0;
+       uint32_t instr = 0;
+       bool final_check = 0;           /* set to 1 if in final checks after function code shifted out */
+       bool pass = 0;                  /* to check the pass through pracc text after function code sent */
        int retval;
-       int pass = 0;
-
-       ctx.local_iparam = param_in;
-       ctx.local_oparam = param_out;
-       ctx.num_iparam = num_param_in;
-       ctx.num_oparam = num_param_out;
-       ctx.code = code;
-       ctx.code_len = code_len;
-       ctx.ejtag_info = ejtag_info;
-       ctx.stack_offset = 0;
 
        while (1) {
-               retval = wait_for_pracc_rw(ejtag_info, &ejtag_ctrl);
-               if (retval != ERROR_OK)
-                       return retval;
+               if (restart) {
+                       if (restart_count < 3) {                                        /* max 3 restarts allowed */
+                               retval = mips32_pracc_clean_text_jump(ejtag_info);
+                               if (retval != ERROR_OK)
+                                       return retval;
+                       } else
+                               return ERROR_JTAG_DEVICE_ERROR;
+                       restart_count++;
+                       restart = 0;
+                       code_count = 0;
+                       LOG_DEBUG("restarting code");
+               }
 
-               address = 0;
-               mips_ejtag_set_instr(ejtag_info, EJTAG_INST_ADDRESS);
-               retval = mips_ejtag_drscan_32(ejtag_info, &address);
+               retval = mips32_pracc_read_ctrl_addr(ejtag_info);               /* update current pa info: control and address */
                if (retval != ERROR_OK)
                        return retval;
 
-               /* Check for read or write */
-               if (ejtag_ctrl & EJTAG_CTRL_PRNW) {
-                       retval = mips32_pracc_exec_write(&ctx, address);
-                       if (retval != ERROR_OK)
-                               return retval;
-               } else {
-                       /* Check to see if its reading at the debug vector. The first pass through
-                        * the module is always read at the vector, so the first one we allow.  When
-                        * the second read from the vector occurs we are done and just exit. */
-                       if ((address == MIPS32_PRACC_TEXT) && (pass++))
-                               break;
+               /* Check for read or write access */
+               if (ejtag_info->pa_ctrl & EJTAG_CTRL_PRNW) {                                            /* write/store access */
+                       /* Check for pending store from a previous store instruction at dmseg */
+                       if (store_pending == 0) {
+                               LOG_DEBUG("unexpected write at address %" PRIx32, ejtag_info->pa_addr);
+                               if (code_count < 2) {   /* allow for restart */
+                                       restart = 1;
+                                       continue;
+                               } else
+                                       return ERROR_JTAG_DEVICE_ERROR;
+                       } else {
+                               /* check address */
+                               if (ejtag_info->pa_addr < MIPS32_PRACC_PARAM_OUT || ejtag_info->pa_addr > max_store_addr) {
 
-                       retval = mips32_pracc_exec_read(&ctx, address);
+                                       LOG_DEBUG("writing at unexpected address %" PRIx32, ejtag_info->pa_addr);
+                                       return ERROR_JTAG_DEVICE_ERROR;
+                               }
+                       }
+                       /* read data */
+                       uint32_t data = 0;
+                       mips_ejtag_set_instr(ejtag_info, EJTAG_INST_DATA);
+                       retval = mips_ejtag_drscan_32(ejtag_info, &data);
                        if (retval != ERROR_OK)
                                return retval;
-               }
 
-               if (cycle == 0)
-                       break;
-       }
+                       /* store data at param out, address based offset */
+                       param_out[(ejtag_info->pa_addr - MIPS32_PRACC_PARAM_OUT) / 4] = data;
+                       store_pending--;
+
+               } else {                                        /* read/fetch access */
+                        if (!final_check) {                    /* executing function code */
+                               /* check address */
+                               if (ejtag_info->pa_addr != (MIPS32_PRACC_TEXT + code_count * 4)) {
+                                       LOG_DEBUG("reading at unexpected address %" PRIx32 ", expected %x",
+                                                       ejtag_info->pa_addr, MIPS32_PRACC_TEXT + code_count * 4);
+
+                                       /* restart code execution only in some cases */
+                                       if (code_count == 1 && ejtag_info->pa_addr == MIPS32_PRACC_TEXT && restart_count == 0) {
+                                               LOG_DEBUG("restarting, without clean jump");
+                                               restart_count++;
+                                               code_count = 0;
+                                               continue;
+                                       } else if (code_count < 2) {
+                                               restart = 1;
+                                               continue;
+                                       }
+
+                                       return ERROR_JTAG_DEVICE_ERROR;
+                               }
+                               /* check for store instruction at dmseg */
+                               uint32_t store_addr = ctx->pracc_list[ctx->max_code + code_count];
+                               if (store_addr != 0) {
+                                       if (store_addr > max_store_addr)
+                                               max_store_addr = store_addr;
+                                       store_pending++;
+                               }
+
+                               instr = ctx->pracc_list[code_count++];
+                               if (code_count == ctx->code_count)      /* last instruction, start final check */
+                                       final_check = 1;
+
+                        } else {       /* final check after function code shifted out */
+                                       /* check address */
+                               if (ejtag_info->pa_addr == MIPS32_PRACC_TEXT) {
+                                       if (!pass) {    /* first pass through pracc text */
+                                               if (store_pending == 0)         /* done, normal exit */
+                                                       return ERROR_OK;
+                                               pass = 1;               /* pracc text passed */
+                                               code_count = 0;         /* restart code count */
+                                       } else {
+                                               LOG_DEBUG("unexpected second pass through pracc text");
+                                               return ERROR_JTAG_DEVICE_ERROR;
+                                       }
+                               } else {
+                                       if (ejtag_info->pa_addr != (MIPS32_PRACC_TEXT + code_count * 4)) {
+                                               LOG_DEBUG("unexpected read address in final check: %" PRIx32 ", expected: %x",
+                                                         ejtag_info->pa_addr, MIPS32_PRACC_TEXT + code_count * 4);
+                                               return ERROR_JTAG_DEVICE_ERROR;
+                                       }
+                               }
+                               if (!pass) {
+                                       if ((code_count - ctx->code_count) > 1) {        /* allow max 2 instruction delay slot */
+                                               LOG_DEBUG("failed to jump back to pracc text");
+                                               return ERROR_JTAG_DEVICE_ERROR;
+                                       }
+                               } else
+                                       if (code_count > 10) {          /* enough, abandone */
+                                               LOG_DEBUG("execution abandoned, store pending: %d", store_pending);
+                                               return ERROR_JTAG_DEVICE_ERROR;
+                                       }
+                               instr = MIPS32_NOP;     /* shift out NOPs instructions */
+                               code_count++;
+                        }
+
+                       /* Send instruction out */
+                       mips_ejtag_set_instr(ejtag_info, EJTAG_INST_DATA);
+                       mips_ejtag_drscan_32_out(ejtag_info, instr);
+               }
+               /* finish processor access, let the processor eat! */
+               retval = mips32_pracc_finish(ejtag_info);
+               if (retval != ERROR_OK)
+                       return retval;
 
-       /* stack sanity check */
-       if (ctx.stack_offset != 0)
-               LOG_DEBUG("Pracc Stack not zero");
+               if (instr == MIPS32_DRET)       /* after leaving debug mode nothing to do */
+                       return ERROR_OK;
 
-       return ERROR_OK;
+               if (store_pending == 0 && pass) {       /* store access done, but after passing pracc text */
+                       LOG_DEBUG("warning: store access pass pracc text");
+                       return ERROR_OK;
+               }
+       }
 }
 
 inline void pracc_queue_init(struct pracc_queue_info *ctx)
@@ -302,8 +353,7 @@ inline void pracc_queue_free(struct pracc_queue_info *ctx)
 int mips32_pracc_queue_exec(struct mips_ejtag *ejtag_info, struct pracc_queue_info *ctx, uint32_t *buf)
 {
        if (ejtag_info->mode == 0)
-               return mips32_pracc_exec(ejtag_info, ctx->code_count, ctx->pracc_list, 0, NULL,
-                                 ctx->store_count, buf, ctx->code_count - 1);
+               return mips32_pracc_exec(ejtag_info, ctx, buf);
 
        union scan_in {
                uint8_t scan_96[12];

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)