hla_transport.c

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
 
/***************************************************************************
 *   Copyright (C) 2011 by Mathias Kuester                                 *
 *   Mathias Kuester <kesmtp@freenet.de>                                   *
 *                                                                         *
 *   Copyright (C) 2012 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 ***************************************************************************/
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
/* project specific includes */
#include <jtag/interface.h>
#include <jtag/tcl.h>
#include <transport/transport.h>
#include <helper/time_support.h>
#include <target/target.h>
#include <jtag/hla/hla_transport.h>
#include <jtag/hla/hla_interface.h>
 
COMMAND_HANDLER(hl_transport_jtag_command)
{
    LOG_DEBUG("hl_transport_jtag_command");
 
    return ERROR_OK;
}
 
COMMAND_HANDLER(hl_transport_reset_command)
{
    return hl_interface_init_reset();
}
 
static const struct command_registration hl_swd_transport_subcommand_handlers[] = {
    {
     .name = "newdap",
     .mode = COMMAND_CONFIG,
     .handler = handle_jtag_newtap,
     .help = "declare a new SWD DAP",
     .usage = "basename dap_type ['-irlen' count] "
            "['-enable'|'-disable'] "
            "['-expected_id' number] "
            "['-ignore-version'] "
            "['-ignore-bypass'] "
            "['-ircapture' number] "
            "['-ir-bypass' number] "
            "['-mask' number]",
     },
    COMMAND_REGISTRATION_DONE
};
 
static const struct command_registration hl_swd_transport_command_handlers[] = {
    {
     .name = "swd",
     .mode = COMMAND_ANY,
     .help = "SWD command group",
     .usage = "",
     .chain = hl_swd_transport_subcommand_handlers,
     },
    COMMAND_REGISTRATION_DONE
};
 
static const struct command_registration hl_transport_jtag_subcommand_handlers[] = {
    {
     .name = "newtap",
     .mode = COMMAND_CONFIG,
     .handler = handle_jtag_newtap,
     .help = "Create a new TAP instance named basename.tap_type, "
     "and appends it to the scan chain.",
     .usage = "basename tap_type '-irlen' count "
            "['-enable'|'-disable'] "
            "['-expected_id' number] "
            "['-ignore-version'] "
            "['-ignore-bypass'] "
            "['-ircapture' number] "
            "['-ir-bypass' number] "
            "['-mask' number]",
     },
    {
     .name = "init",
     .mode = COMMAND_ANY,
     .handler = hl_transport_jtag_command,
     .usage = ""
     },
    {
     .name = "arp_init",
     .mode = COMMAND_ANY,
     .handler = hl_transport_jtag_command,
     .usage = ""
     },
    {
     .name = "arp_init-reset",
     .mode = COMMAND_ANY,
     .handler = hl_transport_reset_command,
     .usage = ""
     },
    {
     .name = "tapisenabled",
     .mode = COMMAND_EXEC,
     .handler = handle_jtag_tap_enabler,
     .help = "Returns a Tcl boolean (0/1) indicating whether "
        "the TAP is enabled (1) or not (0).",
     .usage = "tap_name",
     },
    {
     .name = "tapenable",
     .mode = COMMAND_EXEC,
     .handler = handle_jtag_tap_enabler,
     .help = "Try to enable the specified TAP using the "
        "'tap-enable' TAP event.",
     .usage = "tap_name",
     },
    {
     .name = "tapdisable",
     .mode = COMMAND_EXEC,
     .handler = hl_transport_jtag_command,
     .usage = "",
     },
    {
     .name = "configure",
     .mode = COMMAND_EXEC,
     .handler = hl_transport_jtag_command,
     .usage = "",
     },
    {
     .name = "cget",
     .mode = COMMAND_EXEC,
     .handler = handle_jtag_configure,
     .usage = "",
     },
    {
     .name = "names",
     .mode = COMMAND_ANY,
     .handler = hl_transport_jtag_command,
     .usage = "",
     },
 
    COMMAND_REGISTRATION_DONE
};
 
static const struct command_registration hl_jtag_transport_command_handlers[] = {
    {
     .name = "jtag",
     .mode = COMMAND_ANY,
     .help = "perform jtag tap actions",
     .usage = "",
     .chain = hl_transport_jtag_subcommand_handlers,
     },
    {
     .name = "jtag_ntrst_delay",
     .mode = COMMAND_ANY,
     .handler = hl_transport_jtag_command,
     .usage = "",
     },
    COMMAND_REGISTRATION_DONE
};
 
 
static int hl_transport_init(struct command_context *cmd_ctx)
{
    LOG_DEBUG("hl_transport_init");
    struct target *t = get_current_target(cmd_ctx);
    struct transport *transport;
    enum hl_transports tr;
 
    if (!t) {
        LOG_ERROR("no current target");
        return ERROR_FAIL;
    }
 
    transport = get_current_transport();
 
    if (!transport) {
        LOG_ERROR("no transport selected");
        return ERROR_FAIL;
    }
 
    LOG_DEBUG("current transport %s", transport->name);
 
    /* get selected transport as enum */
    tr = HL_TRANSPORT_UNKNOWN;
 
    if (strcmp(transport->name, "hla_swd") == 0)
        tr = HL_TRANSPORT_SWD;
    else if (strcmp(transport->name, "hla_jtag") == 0)
        tr = HL_TRANSPORT_JTAG;
 
    int retval = hl_interface_open(tr);
 
    if (retval != ERROR_OK)
        return retval;
 
    return hl_interface_init_target(t);
}
 
static int hl_jtag_transport_select(struct command_context *cmd_ctx)
{
    LOG_DEBUG("hl_jtag_transport_select");
 
    /* NOTE:  interface init must already have been done.
     * That works with only C code ... no Tcl glue required.
     */
 
    return register_commands(cmd_ctx, NULL, hl_jtag_transport_command_handlers);
}
 
static int hl_swd_transport_select(struct command_context *cmd_ctx)
{
    LOG_DEBUG("hl_swd_transport_select");
    return register_commands(cmd_ctx, NULL, hl_swd_transport_command_handlers);
}
 
static struct transport hl_swd_transport = {
    .name = "hla_swd",
    .select = hl_swd_transport_select,
    .init = hl_transport_init,
    .override_target = hl_interface_override_target,
};
 
static struct transport hl_jtag_transport = {
    .name = "hla_jtag",
    .select = hl_jtag_transport_select,
    .init = hl_transport_init,
    .override_target = hl_interface_override_target,
};
 
const char *hl_transports[] = { "hla_swd", "hla_jtag", NULL };
 
static void hl_constructor(void) __attribute__ ((constructor));
static void hl_constructor(void)
{
    transport_register(&hl_swd_transport);
    transport_register(&hl_jtag_transport);
}
 
bool transport_is_hla(void)
{
    struct transport *t;
    t = get_current_transport();
    return t == &hl_swd_transport || t == &hl_jtag_transport;
}