arm_adi_v5: Make the DAP API stateless
[openocd.git] / src / target / adi_v5_jtag.c
index b6473b01bf5c5a9851e7775f89929ad134ec4af1..b71fe3820ea53e20d02041a98164b61b1c448612 100644 (file)
@@ -23,7 +23,7 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the
  *   Free Software Foundation, Inc.,
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  ***************************************************************************/
 
 /**
@@ -50,6 +50,8 @@
 #define JTAG_ACK_OK_FAULT      0x2
 #define JTAG_ACK_WAIT          0x1
 
+static int jtag_ap_q_abort(struct adiv5_dap *dap, uint8_t *ack);
+
 /***************************************************************************
  *
  * DPACC and APACC scanchain access through JTAG-DP (or SWJ-DP)
  * @param outvalue points to a 32-bit (little-endian) integer
  * @param invalue NULL, or points to a 32-bit (little-endian) integer
  * @param ack points to where the three bit JTAG_ACK_* code will be stored
+ * @param memaccess_tck number of idle cycles to add after AP access
  */
 
-/* FIXME don't export ... this is a temporary workaround for the
- * mem_ap_read_buf_u32() mess, until it's no longer JTAG-specific.
- */
-int adi_jtag_dp_scan(struct adiv5_dap *dap,
+static int adi_jtag_dp_scan(struct adiv5_dap *dap,
                uint8_t instr, uint8_t reg_addr, uint8_t RnW,
-               uint8_t *outvalue, uint8_t *invalue, uint8_t *ack)
+               uint8_t *outvalue, uint8_t *invalue, uint8_t *ack,
+               uint32_t memaccess_tck)
 {
-       struct arm_jtag *jtag_info = dap->jtag_info;
+       struct jtag_tap *tap = dap->tap;
        struct scan_field fields[2];
        uint8_t out_addr_buf;
        int retval;
 
-       retval = arm_jtag_set_instr(jtag_info, instr, NULL, TAP_IDLE);
+       retval = arm_jtag_set_instr(tap, instr, NULL, TAP_IDLE);
        if (retval != ERROR_OK)
                return retval;
 
@@ -108,7 +109,7 @@ int adi_jtag_dp_scan(struct adiv5_dap *dap,
        fields[1].out_value = outvalue;
        fields[1].in_value = invalue;
 
-       jtag_add_dr_scan(jtag_info->tap, 2, fields, TAP_IDLE);
+       jtag_add_dr_scan(tap, 2, fields, TAP_IDLE);
 
        /* Add specified number of tck clocks after starting memory bus
         * access, giving the hardware time to complete the access.
@@ -116,11 +117,10 @@ int adi_jtag_dp_scan(struct adiv5_dap *dap,
         * See "Minimum Response Time" for JTAG-DP, in the ADIv5 spec.
         */
        if ((instr == JTAG_DP_APACC)
-                       && ((reg_addr == AP_REG_DRW)
-                               || ((reg_addr & 0xF0) == AP_REG_BD0))
-                       && (dap->memaccess_tck != 0))
-               jtag_add_runtest(dap->memaccess_tck,
-                               TAP_IDLE);
+                       && ((reg_addr == MEM_AP_REG_DRW)
+                               || ((reg_addr & 0xF0) == MEM_AP_REG_BD0))
+                       && memaccess_tck != 0)
+               jtag_add_runtest(memaccess_tck, TAP_IDLE);
 
        return ERROR_OK;
 }
@@ -133,7 +133,8 @@ int adi_jtag_dp_scan(struct adiv5_dap *dap,
  */
 static int adi_jtag_dp_scan_u32(struct adiv5_dap *dap,
                uint8_t instr, uint8_t reg_addr, uint8_t RnW,
-               uint32_t outvalue, uint32_t *invalue, uint8_t *ack)
+               uint32_t outvalue, uint32_t *invalue, uint8_t *ack,
+               uint32_t memaccess_tck)
 {
        uint8_t out_value_buf[4];
        int retval;
@@ -141,7 +142,7 @@ static int adi_jtag_dp_scan_u32(struct adiv5_dap *dap,
        buf_set_u32(out_value_buf, 0, 32, outvalue);
 
        retval = adi_jtag_dp_scan(dap, instr, reg_addr, RnW,
-                       out_value_buf, (uint8_t *)invalue, ack);
+                       out_value_buf, (uint8_t *)invalue, ack, memaccess_tck);
        if (retval != ERROR_OK)
                return retval;
 
@@ -155,22 +156,22 @@ static int adi_jtag_dp_scan_u32(struct adiv5_dap *dap,
 /**
  * Utility to write AP registers.
  */
-static inline int adi_jtag_ap_write_check(struct adiv5_dap *dap,
+static inline int adi_jtag_ap_write_check(struct adiv5_ap *ap,
                uint8_t reg_addr, uint8_t *outvalue)
 {
-       return adi_jtag_dp_scan(dap, JTAG_DP_APACC, reg_addr, DPAP_WRITE,
-                       outvalue, NULL, NULL);
+       return adi_jtag_dp_scan(ap->dap, JTAG_DP_APACC, reg_addr, DPAP_WRITE,
+                       outvalue, NULL, NULL, ap->memaccess_tck);
 }
 
 static int adi_jtag_scan_inout_check_u32(struct adiv5_dap *dap,
                uint8_t instr, uint8_t reg_addr, uint8_t RnW,
-               uint32_t outvalue, uint32_t *invalue)
+               uint32_t outvalue, uint32_t *invalue, uint32_t memaccess_tck)
 {
        int retval;
 
        /* Issue the read or write */
        retval = adi_jtag_dp_scan_u32(dap, instr, reg_addr,
-                       RnW, outvalue, NULL, NULL);
+                       RnW, outvalue, NULL, NULL, memaccess_tck);
        if (retval != ERROR_OK)
                return retval;
 
@@ -179,7 +180,7 @@ static int adi_jtag_scan_inout_check_u32(struct adiv5_dap *dap,
         */
        if ((RnW == DPAP_READ) && (invalue != NULL))
                retval = adi_jtag_dp_scan_u32(dap, JTAG_DP_DPACC,
-                               DP_RDBUFF, DPAP_READ, 0, invalue, &dap->ack);
+                               DP_RDBUFF, DPAP_READ, 0, invalue, &dap->ack, 0);
        return retval;
 }
 
@@ -219,7 +220,7 @@ static int jtagdp_transaction_endcheck(struct adiv5_dap *dap)
         * but collect its ACK status.
         */
        retval = adi_jtag_scan_inout_check_u32(dap, JTAG_DP_DPACC,
-                       DP_CTRL_STAT, DPAP_READ, 0, &ctrlstat);
+                       DP_CTRL_STAT, DPAP_READ, 0, &ctrlstat, 0);
        if (retval != ERROR_OK)
                return retval;
        retval = jtag_execute_queue();
@@ -235,12 +236,16 @@ static int jtagdp_transaction_endcheck(struct adiv5_dap *dap)
                while (dap->ack != JTAG_ACK_OK_FAULT) {
                        if (dap->ack == JTAG_ACK_WAIT) {
                                if ((timeval_ms()-then) > 1000) {
-                                       /* NOTE:  this would be a good spot
-                                        * to use JTAG_DP_ABORT.
-                                        */
                                        LOG_WARNING("Timeout (1000ms) waiting "
                                                "for ACK=OK/FAULT "
-                                               "in JTAG-DP transaction");
+                                               "in JTAG-DP transaction - aborting");
+
+                                       uint8_t ack;
+                                       int abort_ret = jtag_ap_q_abort(dap, &ack);
+
+                                       if (abort_ret != 0)
+                                               LOG_WARNING("Abort failed : return=%d ack=%d", abort_ret, ack);
+
                                        return ERROR_JTAG_DEVICE_ERROR;
                                }
                        } else {
@@ -251,10 +256,10 @@ static int jtagdp_transaction_endcheck(struct adiv5_dap *dap)
                        }
 
                        retval = adi_jtag_scan_inout_check_u32(dap, JTAG_DP_DPACC,
-                                       DP_CTRL_STAT, DPAP_READ, 0, &ctrlstat);
+                                       DP_CTRL_STAT, DPAP_READ, 0, &ctrlstat, 0);
                        if (retval != ERROR_OK)
                                return retval;
-                       retval = dap_run(dap);
+                       retval = jtag_execute_queue();
                        if (retval != ERROR_OK)
                                return retval;
                        dap->ack = dap->ack & 0x7;
@@ -268,25 +273,9 @@ static int jtagdp_transaction_endcheck(struct adiv5_dap *dap)
                LOG_DEBUG("jtag-dp: CTRL/STAT error, 0x%" PRIx32, ctrlstat);
                /* Check power to debug regions */
                if ((ctrlstat & 0xf0000000) != 0xf0000000) {
-                       retval = ahbap_debugport_init(dap);
-                       if (retval != ERROR_OK)
-                               return retval;
+                       LOG_ERROR("Debug regions are unpowered, an unexpected reset might have happened");
+                       return ERROR_JTAG_DEVICE_ERROR;
                } else {
-                       uint32_t mem_ap_csw, mem_ap_tar;
-
-                       /* Maybe print information about last intended
-                        * MEM-AP access; but not if autoincrementing.
-                        * *Real* CSW and TAR values are always shown.
-                        */
-                       if (dap->ap_tar_value != (uint32_t) -1)
-                               LOG_DEBUG("MEM-AP Cached values: "
-                                       "ap_bank 0x%" PRIx32
-                                       ", ap_csw 0x%" PRIx32
-                                       ", ap_tar 0x%" PRIx32,
-                                       dap->ap_bank_value,
-                                       dap->ap_csw_value,
-                                       dap->ap_tar_value);
-
                        if (ctrlstat & SSTICKYORUN)
                                LOG_ERROR("JTAG-DP OVERRUN - check clock, "
                                        "memaccess, or reduce jtag speed");
@@ -298,37 +287,20 @@ static int jtagdp_transaction_endcheck(struct adiv5_dap *dap)
                        retval = adi_jtag_scan_inout_check_u32(dap, JTAG_DP_DPACC,
                                        DP_CTRL_STAT, DPAP_WRITE,
                                        dap->dp_ctrl_stat | SSTICKYORUN
-                                               | SSTICKYERR, NULL);
+                                               | SSTICKYERR, NULL, 0);
                        if (retval != ERROR_OK)
                                return retval;
                        retval = adi_jtag_scan_inout_check_u32(dap, JTAG_DP_DPACC,
-                                       DP_CTRL_STAT, DPAP_READ, 0, &ctrlstat);
+                                       DP_CTRL_STAT, DPAP_READ, 0, &ctrlstat, 0);
                        if (retval != ERROR_OK)
                                return retval;
-                       retval = dap_run(dap);
+                       retval = jtag_execute_queue();
                        if (retval != ERROR_OK)
                                return retval;
 
                        LOG_DEBUG("jtag-dp: CTRL/STAT 0x%" PRIx32, ctrlstat);
-
-                       retval = dap_queue_ap_read(dap,
-                                       AP_REG_CSW, &mem_ap_csw);
-                       if (retval != ERROR_OK)
-                               return retval;
-
-                       retval = dap_queue_ap_read(dap,
-                                       AP_REG_TAR, &mem_ap_tar);
-                       if (retval != ERROR_OK)
-                               return retval;
-
-                       retval = dap_run(dap);
-                       if (retval != ERROR_OK)
-                               return retval;
-                       LOG_ERROR("MEM_AP_CSW 0x%" PRIx32 ", MEM_AP_TAR 0x%"
-                                       PRIx32, mem_ap_csw, mem_ap_tar);
-
                }
-               retval = dap_run(dap);
+               retval = jtag_execute_queue();
                if (retval != ERROR_OK)
                        return retval;
                return ERROR_JTAG_DEVICE_ERROR;
@@ -339,89 +311,65 @@ static int jtagdp_transaction_endcheck(struct adiv5_dap *dap)
 
 /*--------------------------------------------------------------------------*/
 
-static int jtag_idcode_q_read(struct adiv5_dap *dap,
-               uint8_t *ack, uint32_t *data)
-{
-       struct arm_jtag *jtag_info = dap->jtag_info;
-       int retval;
-       struct scan_field fields[1];
-
-       /* This is a standard JTAG operation -- no DAP tweakage */
-       retval = arm_jtag_set_instr(jtag_info, JTAG_DP_IDCODE, NULL, TAP_IDLE);
-       if (retval != ERROR_OK)
-               return retval;
-
-       fields[0].num_bits = 32;
-       fields[0].out_value = NULL;
-       fields[0].in_value = (void *) data;
-
-       jtag_add_dr_scan(jtag_info->tap, 1, fields, TAP_IDLE);
-
-       jtag_add_callback(arm_le_to_h_u32,
-                       (jtag_callback_data_t) data);
-
-       return ERROR_OK;
-}
-
 static int jtag_dp_q_read(struct adiv5_dap *dap, unsigned reg,
                uint32_t *data)
 {
        return adi_jtag_scan_inout_check_u32(dap, JTAG_DP_DPACC,
-                       reg, DPAP_READ, 0, data);
+                       reg, DPAP_READ, 0, data, 0);
 }
 
 static int jtag_dp_q_write(struct adiv5_dap *dap, unsigned reg,
                uint32_t data)
 {
        return adi_jtag_scan_inout_check_u32(dap, JTAG_DP_DPACC,
-                       reg, DPAP_WRITE, data, NULL);
+                       reg, DPAP_WRITE, data, NULL, 0);
 }
 
 /** Select the AP register bank matching bits 7:4 of reg. */
-static int jtag_ap_q_bankselect(struct adiv5_dap *dap, unsigned reg)
+static int jtag_ap_q_bankselect(struct adiv5_ap *ap, unsigned reg)
 {
-       uint32_t select_ap_bank = reg & 0x000000F0;
+       struct adiv5_dap *dap = ap->dap;
+       uint32_t select = ((uint32_t)ap->ap_num << 24) | (reg & 0x000000F0);
 
-       if (select_ap_bank == dap->ap_bank_value)
+       if (select == dap->select)
                return ERROR_OK;
-       dap->ap_bank_value = select_ap_bank;
 
-       select_ap_bank |= dap->ap_current;
+       dap->select = select;
 
-       return jtag_dp_q_write(dap, DP_SELECT, select_ap_bank);
+       return jtag_dp_q_write(dap, DP_SELECT, select);
 }
 
-static int jtag_ap_q_read(struct adiv5_dap *dap, unsigned reg,
+static int jtag_ap_q_read(struct adiv5_ap *ap, unsigned reg,
                uint32_t *data)
 {
-       int retval = jtag_ap_q_bankselect(dap, reg);
+       int retval = jtag_ap_q_bankselect(ap, reg);
 
        if (retval != ERROR_OK)
                return retval;
 
-       return adi_jtag_scan_inout_check_u32(dap, JTAG_DP_APACC, reg,
-                       DPAP_READ, 0, data);
+       return adi_jtag_scan_inout_check_u32(ap->dap, JTAG_DP_APACC, reg,
+                       DPAP_READ, 0, data, ap->memaccess_tck);
 }
 
-static int jtag_ap_q_write(struct adiv5_dap *dap, unsigned reg,
+static int jtag_ap_q_write(struct adiv5_ap *ap, unsigned reg,
                uint32_t data)
 {
        uint8_t out_value_buf[4];
 
-       int retval = jtag_ap_q_bankselect(dap, reg);
+       int retval = jtag_ap_q_bankselect(ap, reg);
        if (retval != ERROR_OK)
                return retval;
 
        buf_set_u32(out_value_buf, 0, 32, data);
 
-       return adi_jtag_ap_write_check(dap, reg, out_value_buf);
+       return adi_jtag_ap_write_check(ap, reg, out_value_buf);
 }
 
 static int jtag_ap_q_abort(struct adiv5_dap *dap, uint8_t *ack)
 {
        /* for JTAG, this is the only valid ABORT register operation */
        return adi_jtag_dp_scan_u32(dap, JTAG_DP_ABORT,
-                       0, DPAP_WRITE, 1, NULL, ack);
+                       0, DPAP_WRITE, 1, NULL, ack, 0);
 }
 
 static int jtag_dp_run(struct adiv5_dap *dap)
@@ -433,13 +381,12 @@ static int jtag_dp_run(struct adiv5_dap *dap)
  * part of DAP setup
 */
 const struct dap_ops jtag_dp_ops = {
-       .queue_idcode_read =    jtag_idcode_q_read,
-       .queue_dp_read =        jtag_dp_q_read,
-       .queue_dp_write =       jtag_dp_q_write,
-       .queue_ap_read =        jtag_ap_q_read,
-       .queue_ap_write =       jtag_ap_q_write,
-       .queue_ap_abort =       jtag_ap_q_abort,
-       .run =                  jtag_dp_run,
+       .queue_dp_read       = jtag_dp_q_read,
+       .queue_dp_write      = jtag_dp_q_write,
+       .queue_ap_read       = jtag_ap_q_read,
+       .queue_ap_write      = jtag_ap_q_write,
+       .queue_ap_abort      = jtag_ap_q_abort,
+       .run                 = jtag_dp_run,
 };
 
 

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)