hla: add a way to pass arbitrary commands from user to layout and use for ICDI

[openocd.git] / src / jtag / hla / hla_interface.c

diff --git a/src/jtag/hla/hla_interface.c b/src/jtag/hla/hla_interface.c
index 8453a6ff5395dedab8e2b2bd60bc9e45a528ebfb..ce914ea0c52204f9fefaa9481ba38c038ade791f 100644 (file)
--- a/src/jtag/hla/hla_interface.c
+++ b/src/jtag/hla/hla_interface.c
@@ -18,7 +18,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.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -37,7 +37,7 @@
 
 #include <target/target.h>
 
-static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, HL_TRANSPORT_UNKNOWN, 0, false}, 0, 0 };
+static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, HL_TRANSPORT_UNKNOWN, false, NULL, 0}, 0, 0 };
 
 int hl_interface_open(enum hl_transports tr)
 {
@@ -72,7 +72,7 @@ int hl_interface_init_target(struct target *t)
         * can setup the private pointer in the tap structure
         * if the interface match the tap idcode
         */
-       res = hl_if.layout->api->idcode(hl_if.fd, &t->tap->idcode);
+       res = hl_if.layout->api->idcode(hl_if.handle, &t->tap->idcode);
 
        if (res != ERROR_OK)
                return res;
@@ -84,14 +84,15 @@ int hl_interface_init_target(struct target *t)
                uint32_t expected = t->tap->expected_ids[ii];
 
                /* treat "-expected-id 0" as a "don't-warn" wildcard */
-               if (!expected || (t->tap->idcode == expected)) {
+               if (!expected || !t->tap->idcode ||
+                   (t->tap->idcode == expected)) {
                        found = 1;
                        break;
                }
        }
 
        if (found == 0) {
-               LOG_ERROR("hl_interface_init_target: target not found: idcode: 0x%08x",
+               LOG_ERROR("hl_interface_init_target: target not found: idcode: 0x%08" PRIx32,
                                t->tap->idcode);
                return ERROR_FAIL;
        }
@@ -114,6 +115,12 @@ static int hl_interface_quit(void)
 {
        LOG_DEBUG("hl_interface_quit");
 
+       if (hl_if.param.trace_f) {
+               fclose(hl_if.param.trace_f);
+               hl_if.param.trace_f = NULL;
+       }
+       hl_if.param.trace_source_hz = 0;
+
        return ERROR_OK;
 }
 
@@ -130,12 +137,43 @@ int hl_interface_init_reset(void)
         * we will attempt it again */
        if (hl_if.param.connect_under_reset) {
                jtag_add_reset(0, 1);
-               hl_if.layout->api->assert_srst(hl_if.fd, 0);
+               hl_if.layout->api->assert_srst(hl_if.handle, 0);
+       } else {
+               jtag_add_reset(0, 0);
        }
 
        return ERROR_OK;
 }
 
+static int dummy_khz(int khz, int *jtag_speed)
+{
+       *jtag_speed = khz;
+       return ERROR_OK;
+}
+
+static int dummy_speed_div(int speed, int *khz)
+{
+       *khz = speed;
+       return ERROR_OK;
+}
+
+static int dummy_speed(int speed)
+{
+       return ERROR_OK;
+}
+
+int hl_interface_override_target(const char **targetname)
+{
+       if (hl_if.layout->api->override_target) {
+               if (hl_if.layout->api->override_target(*targetname)) {
+                       *targetname = "hla_target";
+                       return ERROR_OK;
+               } else
+                       return ERROR_FAIL;
+       }
+       return ERROR_FAIL;
+}
+
 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
 {
        LOG_DEBUG("hl_interface_handle_device_desc_command");
@@ -205,17 +243,42 @@ COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(stlink_interface_handle_api_command)
+COMMAND_HANDLER(interface_handle_trace_command)
 {
-       if (CMD_ARGC != 1)
+       FILE *f = NULL;
+       unsigned source_hz;
+
+       if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       unsigned new_api;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
-       if ((new_api == 0) || (new_api > 2))
+       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], source_hz);
+       if (source_hz == 0) {
                return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
+       if (CMD_ARGC == 2) {
+               f = fopen(CMD_ARGV[1], "a");
+               if (!f)
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+       }
 
-       hl_if.param.api = new_api;
+       hl_if.param.trace_f = f;
+       hl_if.param.trace_source_hz = source_hz;
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(interface_handle_hla_command)
+{
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       if (!hl_if.layout->api->custom_command) {
+               LOG_ERROR("The selected adapter doesn't support custom commands");
+               return ERROR_FAIL;
+       }
+
+       hl_if.layout->api->custom_command(hl_if.handle, CMD_ARGV[0]);
 
        return ERROR_OK;
 }
@@ -250,11 +313,18 @@ static const struct command_registration hl_interface_command_handlers[] = {
         .usage = "(vid pid)* ",
         },
         {
-        .name = "stlink_api",
-        .handler = &stlink_interface_handle_api_command,
+        .name = "trace",
+        .handler = &interface_handle_trace_command,
         .mode = COMMAND_CONFIG,
-        .help = "set the desired stlink api level",
-        .usage = "api version 1 or 2",
+        .help = "configure trace reception",
+        .usage = "source_lock_hz [destination_path]",
+        },
+        {
+        .name = "hla_command",
+        .handler = &interface_handle_hla_command,
+        .mode = COMMAND_EXEC,
+        .help = "execute a custom adapter-specific command",
+        .usage = "hla_command <command>",
         },
        COMMAND_REGISTRATION_DONE
 };
@@ -267,4 +337,7 @@ struct jtag_interface hl_interface = {
        .init = hl_interface_init,
        .quit = hl_interface_quit,
        .execute_queue = hl_interface_execute_queue,
+       .speed = &dummy_speed,
+       .khz = &dummy_khz,
+       .speed_div = &dummy_speed_div,
 };