arm_dap.c

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
 
/***************************************************************************
 *   Copyright (C) 2016 by Matthias Welwarsky                              *
 *                                                                         *
 ***************************************************************************/
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include <stdlib.h>
#include <stdint.h>
#include "target/arm_adi_v5.h"
#include "target/arm.h"
#include "helper/list.h"
#include "helper/command.h"
#include "transport/transport.h"
#include "jtag/adapter.h"
#include "jtag/interface.h"
 
static OOCD_LIST_HEAD(all_dap);
 
/* DAP command support */
struct arm_dap_object {
    struct list_head lh;
    struct adiv5_dap dap;
    char *name;
    const struct swd_driver *swd;
};
 
static void dap_instance_init(struct adiv5_dap *dap)
{
    int i;
    /* Set up with safe defaults */
    for (i = 0; i <= DP_APSEL_MAX; i++) {
        dap->ap[i].dap = dap;
        dap->ap[i].ap_num = DP_APSEL_INVALID;
        /* memaccess_tck max is 255 */
        dap->ap[i].memaccess_tck = 255;
        /* Number of bits for tar autoincrement, impl. dep. at least 10 */
        dap->ap[i].tar_autoincr_block = (1<<10);
        /* default CSW value */
        dap->ap[i].csw_default = CSW_AHB_DEFAULT;
        dap->ap[i].cfg_reg = MEM_AP_REG_CFG_INVALID; /* mem_ap configuration reg (large physical addr, etc.) */
        dap->ap[i].refcount = 0;
        dap->ap[i].config_ap_never_release = false;
    }
    INIT_LIST_HEAD(&dap->cmd_journal);
    INIT_LIST_HEAD(&dap->cmd_pool);
}
 
const char *adiv5_dap_name(struct adiv5_dap *self)
{
    struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
    return obj->name;
}
 
const struct swd_driver *adiv5_dap_swd_driver(struct adiv5_dap *self)
{
    struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
    return obj->swd;
}
 
struct adiv5_dap *adiv5_get_dap(struct arm_dap_object *obj)
{
    return &obj->dap;
}
struct adiv5_dap *dap_instance_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
{
    struct arm_dap_object *obj = NULL;
    const char *name;
    bool found = false;
 
    name = Jim_GetString(o, NULL);
 
    list_for_each_entry(obj, &all_dap, lh) {
        if (!strcmp(name, obj->name)) {
            found = true;
            break;
        }
    }
 
    if (found)
        return &obj->dap;
    return NULL;
}
 
static int dap_init_all(void)
{
    struct arm_dap_object *obj;
    int retval;
    bool pre_connect = true;
 
    LOG_DEBUG("Initializing all DAPs ...");
 
    list_for_each_entry(obj, &all_dap, lh) {
        struct adiv5_dap *dap = &obj->dap;
 
        /* with hla, dap is just a dummy */
        if (transport_is_hla())
            continue;
 
        /* skip taps that are disabled */
        if (!dap->tap->enabled)
            continue;
 
        if (transport_is_swd()) {
            dap->ops = &swd_dap_ops;
            obj->swd = adapter_driver->swd_ops;
        } else if (transport_is_dapdirect_swd()) {
            dap->ops = adapter_driver->dap_swd_ops;
        } else if (transport_is_dapdirect_jtag()) {
            dap->ops = adapter_driver->dap_jtag_ops;
        } else
            dap->ops = &jtag_dp_ops;
 
        if (dap->adi_version == 0) {
            LOG_DEBUG("DAP %s configured by default to use ADIv5 protocol", jtag_tap_name(dap->tap));
            dap->adi_version = 5;
        } else {
            LOG_DEBUG("DAP %s configured to use %s protocol by user cfg file", jtag_tap_name(dap->tap),
                is_adiv6(dap) ? "ADIv6" : "ADIv5");
        }
 
        if (pre_connect && dap->ops->pre_connect_init) {
            retval = dap->ops->pre_connect_init(dap);
            if (retval != ERROR_OK)
                return retval;
 
            pre_connect = false;
        }
 
        retval = dap->ops->connect(dap);
        if (retval != ERROR_OK)
            return retval;
 
        /* see if address size of ROM Table is greater than 32-bits */
        if (is_adiv6(dap)) {
            uint32_t dpidr1;
 
            retval = dap->ops->queue_dp_read(dap, DP_DPIDR1, &dpidr1);
            if (retval != ERROR_OK) {
                LOG_ERROR("DAP read of DPIDR1 failed...");
                return retval;
            }
            retval = dap_run(dap);
            if (retval != ERROR_OK) {
                LOG_ERROR("DAP read of DPIDR1 failed...");
                return retval;
            }
            dap->asize = dpidr1 & DP_DPIDR1_ASIZE_MASK;
        }
    }
 
    return ERROR_OK;
}
 
int dap_cleanup_all(void)
{
    struct arm_dap_object *obj, *tmp;
    struct adiv5_dap *dap;
 
    list_for_each_entry_safe(obj, tmp, &all_dap, lh) {
        dap = &obj->dap;
        for (unsigned int i = 0; i <= DP_APSEL_MAX; i++) {
            if (dap->ap[i].refcount != 0)
                LOG_ERROR("BUG: refcount AP#%u still %u at exit", i, dap->ap[i].refcount);
        }
        if (dap->ops && dap->ops->quit)
            dap->ops->quit(dap);
 
        free(obj->name);
        free(obj);
    }
 
    return ERROR_OK;
}
 
enum dap_cfg_param {
    CFG_CHAIN_POSITION,
    CFG_TAP,
    CFG_IGNORE_SYSPWRUPACK,
    CFG_DP_ID,
    CFG_INSTANCE_ID,
    CFG_ADIV6,
    CFG_ADIV5,
};
 
static const struct jim_nvp nvp_config_opts[] = {
    { .name = "-chain-position",     .value = CFG_CHAIN_POSITION },
    { .name = "-tap",                .value = CFG_TAP },
    { .name = "-ignore-syspwrupack", .value = CFG_IGNORE_SYSPWRUPACK },
    { .name = "-dp-id",              .value = CFG_DP_ID },
    { .name = "-instance-id",        .value = CFG_INSTANCE_ID },
    { .name = "-adiv6",              .value = CFG_ADIV6 },
    { .name = "-adiv5",              .value = CFG_ADIV5 },
    { .name = NULL, .value = -1 }
};
 
static int dap_configure(struct jim_getopt_info *goi, struct arm_dap_object *dap)
{
    struct jim_nvp *n;
    int e;
 
    /* parse config ... */
    while (goi->argc > 0) {
        Jim_SetEmptyResult(goi->interp);
 
        e = jim_getopt_nvp(goi, nvp_config_opts, &n);
        if (e != JIM_OK) {
            jim_getopt_nvp_unknown(goi, nvp_config_opts, 0);
            return e;
        }
        switch (n->value) {
        case CFG_CHAIN_POSITION:
            LOG_WARNING("[%s] DEPRECATED! '-chain-position' will be removed in the future, use '-tap' instead",
                dap->name);
            /* fallthrough */
        case CFG_TAP: {
            Jim_Obj *o_t;
            e = jim_getopt_obj(goi, &o_t);
            if (e != JIM_OK)
                return e;
 
            struct jtag_tap *tap;
            tap = jtag_tap_by_jim_obj(goi->interp, o_t);
            if (!tap) {
                Jim_SetResultString(goi->interp, "-tap is invalid", -1);
                return JIM_ERR;
            }
            dap->dap.tap = tap;
            /* loop for more */
            break;
        }
        case CFG_IGNORE_SYSPWRUPACK:
            dap->dap.ignore_syspwrupack = true;
            break;
        case CFG_DP_ID: {
            jim_wide w;
            e = jim_getopt_wide(goi, &w);
            if (e != JIM_OK) {
                Jim_SetResultFormatted(goi->interp,
                        "create %s: bad parameter %s",
                        dap->name, n->name);
                return JIM_ERR;
            }
            if (w < 0 || w > DP_TARGETSEL_DPID_MASK) {
                Jim_SetResultFormatted(goi->interp,
                        "create %s: %s out of range",
                        dap->name, n->name);
                return JIM_ERR;
            }
            dap->dap.multidrop_targetsel =
                (dap->dap.multidrop_targetsel & DP_TARGETSEL_INSTANCEID_MASK)
                | (w & DP_TARGETSEL_DPID_MASK);
            dap->dap.multidrop_dp_id_valid = true;
            break;
        }
        case CFG_INSTANCE_ID: {
            jim_wide w;
            e = jim_getopt_wide(goi, &w);
            if (e != JIM_OK) {
                Jim_SetResultFormatted(goi->interp,
                        "create %s: bad parameter %s",
                        dap->name, n->name);
                return JIM_ERR;
            }
            if (w < 0 || w > 15) {
                Jim_SetResultFormatted(goi->interp,
                        "create %s: %s out of range",
                        dap->name, n->name);
                return JIM_ERR;
            }
            dap->dap.multidrop_targetsel =
                (dap->dap.multidrop_targetsel & DP_TARGETSEL_DPID_MASK)
                | ((w << DP_TARGETSEL_INSTANCEID_SHIFT) & DP_TARGETSEL_INSTANCEID_MASK);
            dap->dap.multidrop_instance_id_valid = true;
            break;
        }
        case CFG_ADIV6:
            dap->dap.adi_version = 6;
            break;
        case CFG_ADIV5:
            dap->dap.adi_version = 5;
            break;
        default:
            break;
        }
    }
 
    return JIM_OK;
}
 
static int dap_check_config(struct adiv5_dap *dap)
{
    if (transport_is_jtag() || transport_is_dapdirect_jtag() || transport_is_hla())
        return ERROR_OK;
 
    struct arm_dap_object *obj;
    bool new_multidrop = dap_is_multidrop(dap);
    bool had_multidrop = new_multidrop;
    uint32_t targetsel = dap->multidrop_targetsel;
    unsigned int non_multidrop_count = had_multidrop ? 0 : 1;
 
    list_for_each_entry(obj, &all_dap, lh) {
        struct adiv5_dap *dap_it = &obj->dap;
 
        if (transport_is_swd()) {
            if (dap_is_multidrop(dap_it)) {
                had_multidrop = true;
                if (new_multidrop && dap_it->multidrop_targetsel == targetsel) {
                    uint32_t dp_id = targetsel & DP_TARGETSEL_DPID_MASK;
                    uint32_t instance_id = targetsel >> DP_TARGETSEL_INSTANCEID_SHIFT;
                    LOG_ERROR("%s and %s have the same multidrop selectors -dp-id 0x%08"
                              PRIx32 " and -instance-id 0x%" PRIx32,
                              obj->name, adiv5_dap_name(dap),
                              dp_id, instance_id);
                    return ERROR_FAIL;
                }
            } else {
                non_multidrop_count++;
            }
        } else if (transport_is_dapdirect_swd()) {
            non_multidrop_count++;
        }
    }
 
    if (non_multidrop_count > 1) {
        LOG_ERROR("Two or more SWD non multidrop DAPs are not supported");
        return ERROR_FAIL;
    }
    if (had_multidrop && non_multidrop_count) {
        LOG_ERROR("Mixing of SWD multidrop DAPs and non multidrop DAPs is not supported");
        return ERROR_FAIL;
    }
 
    return ERROR_OK;
}
 
COMMAND_HANDLER(handle_dap_create)
{
    if (CMD_ARGC < 3)
        return ERROR_COMMAND_SYNTAX_ERROR;
 
    int retval = ERROR_COMMAND_ARGUMENT_INVALID;
 
    /* check if the dap name clashes with an existing command name */
    Jim_Cmd *jimcmd = Jim_GetCommand(CMD_CTX->interp, CMD_JIMTCL_ARGV[0], JIM_NONE);
    if (jimcmd) {
        command_print(CMD, "Command/dap: %s Exists", CMD_ARGV[0]);
        return ERROR_FAIL;
    }
 
    /* Create it */
    struct arm_dap_object *dap = calloc(1, sizeof(struct arm_dap_object));
    if (!dap) {
        LOG_ERROR("Out of memory");
        return ERROR_FAIL;
    }
 
    dap_instance_init(&dap->dap);
 
    dap->name = strdup(CMD_ARGV[0]);
    if (!dap->name) {
        LOG_ERROR("Out of memory");
        free(dap);
        return ERROR_FAIL;
    }
 
    struct jim_getopt_info goi;
    jim_getopt_setup(&goi, CMD_CTX->interp, CMD_ARGC - 1, CMD_JIMTCL_ARGV + 1);
    int e = dap_configure(&goi, dap);
    if (e != JIM_OK) {
        int reslen;
        const char *result = Jim_GetString(Jim_GetResult(CMD_CTX->interp), &reslen);
        if (reslen > 0)
            command_print(CMD, "%s", result);
        goto err;
    }
 
    if (!dap->dap.tap) {
        command_print(CMD, "-tap required when creating DAP");
        goto err;
    }
 
    retval = dap_check_config(&dap->dap);
    if (retval != ERROR_OK)
        goto err;
 
    struct command_registration dap_create_commands[] = {
        {
            .name = CMD_ARGV[0],
            .mode = COMMAND_ANY,
            .help = "dap instance command group",
            .usage = "",
            .chain = dap_instance_commands,
        },
        COMMAND_REGISTRATION_DONE
    };
 
    /* don't expose the instance commands when using hla */
    if (transport_is_hla())
        dap_create_commands[0].chain = NULL;
 
    retval = register_commands_with_data(CMD_CTX, NULL, dap_create_commands, dap);
    if (retval != ERROR_OK)
        goto err;
 
    list_add_tail(&dap->lh, &all_dap);
 
    return ERROR_OK;
 
err:
    free(dap->name);
    free(dap);
    return retval;
}
 
static struct adiv5_dap *target_to_dap(const struct target *target)
{
    struct adiv5_private_config *pc = target->private_config;
 
    if (!target->has_dap || !target->dap_configured || !pc)
        return NULL;
 
    return pc->dap;
}
 
COMMAND_HANDLER(handle_dap_names)
{
    if (CMD_ARGC != 0)
        return ERROR_COMMAND_SYNTAX_ERROR;
 
    struct arm_dap_object *obj;
    list_for_each_entry(obj, &all_dap, lh)
        command_print(CMD, "%s", obj->name);
 
    return ERROR_OK;
}
 
COMMAND_HANDLER(handle_dap_init)
{
    return dap_init_all();
}
 
COMMAND_HANDLER(handle_dap_info_command)
{
    struct target *target = get_current_target(CMD_CTX);
    struct adiv5_dap *dap = target_to_dap(target);
    uint64_t apsel;
 
    if (!dap) {
        command_print(CMD, "target %s has no DAP", target_name(target));
        return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
    }
 
    switch (CMD_ARGC) {
    case 0:
        apsel = dap->apsel;
        break;
    case 1:
        if (!strcmp(CMD_ARGV[0], "root")) {
            if (!is_adiv6(dap)) {
                command_print(CMD, "Option \"root\" not allowed with ADIv5 DAP");
                return ERROR_COMMAND_ARGUMENT_INVALID;
            }
            int retval = adiv6_dap_read_baseptr(CMD, dap, &apsel);
            if (retval != ERROR_OK) {
                command_print(CMD, "Failed reading DAP baseptr");
                return retval;
            }
            break;
        }
        COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], apsel);
        if (!is_ap_num_valid(dap, apsel))
            return ERROR_COMMAND_SYNTAX_ERROR;
        break;
    default:
        return ERROR_COMMAND_SYNTAX_ERROR;
    }
 
    struct adiv5_ap *ap = dap_get_ap(dap, apsel);
    if (!ap) {
        command_print(CMD, "Cannot get AP");
        return ERROR_FAIL;
    }
    int retval = dap_info_command(CMD, ap);
    dap_put_ap(ap);
    return retval;
}
 
static const struct command_registration dap_subcommand_handlers[] = {
    {
        .name = "create",
        .mode = COMMAND_ANY,
        .handler = handle_dap_create,
        .usage = "name '-tap' name",
        .help = "Creates a new DAP instance",
    },
    {
        .name = "names",
        .mode = COMMAND_ANY,
        .handler = handle_dap_names,
        .usage = "",
        .help = "Lists all registered DAP instances by name",
    },
    {
        .name = "init",
        .mode = COMMAND_ANY,
        .handler = handle_dap_init,
        .usage = "",
        .help = "Initialize all registered DAP instances"
    },
    {
        .name = "info",
        .handler = handle_dap_info_command,
        .mode = COMMAND_EXEC,
        .help = "display ROM table for specified MEM-AP (default MEM-AP of current target) "
            "or the ADIv6 root ROM table of current target's DAP",
        .usage = "[ap_num | 'root']",
    },
    COMMAND_REGISTRATION_DONE
};
 
static const struct command_registration dap_commands[] = {
    {
        .name = "dap",
        .mode = COMMAND_CONFIG,
        .help = "DAP commands",
        .chain = dap_subcommand_handlers,
        .usage = "",
    },
    COMMAND_REGISTRATION_DONE
};
 
int dap_register_commands(struct command_context *cmd_ctx)
{
    return register_commands(cmd_ctx, NULL, dap_commands);
}