Menu
▾
▴
[OpenOCD-commit] Main OpenOCD repository branch, master, updated. v0.12.0-969-ga500b2ce6
|
From: openocd-gerrit <ope...@us...> - 2025-05-01 15:27:08
|
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Main OpenOCD repository".
The branch, master has been updated
via a500b2ce67eb80870dfbd5d73118e822ac99ef88 (commit)
via 236208a5ff2db5f502444b32da1df3fd17b692fb (commit)
via 9a5de74423503d1bd16e16b77b4e0e6d19913057 (commit)
from da50873d5ebe558ee545c1a00f31df9e23f45456 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit a500b2ce67eb80870dfbd5d73118e822ac99ef88
Author: Antonio Borneo <bor...@gm...>
Date: Wed Feb 12 16:39:18 2025 +0100
adapter: use bitmask for driver's transports
In every driver, replace the array of strings with a bitmask that
lists the supported transports.
Add an extra field to carry the former first listed transport as a
"preferred" transport. It would be used as default when no command
'transport select' is used. This keeps backward compatibility with
scripts that do not define the transport, relying on such default.
Change-Id: I4976583f1a38fdcc1f85045023dc7c629001f743
Signed-off-by: Antonio Borneo <bor...@gm...>
Reviewed-on: https://review.openocd.org/c/openocd/+/8675
Tested-by: jenkins
Reviewed-by: zapb <de...@za...>
diff --git a/src/jtag/adapter.c b/src/jtag/adapter.c
index 694721746..6785a74ef 100644
--- a/src/jtag/adapter.c
+++ b/src/jtag/adapter.c
@@ -16,6 +16,7 @@
#include "minidriver.h"
#include "interface.h"
#include "interfaces.h"
+#include <helper/bits.h>
#include <transport/transport.h>
/**
@@ -24,7 +25,6 @@
*/
struct adapter_driver *adapter_driver;
-const char * const jtag_only[] = { "jtag", NULL };
enum adapter_clk_mode {
CLOCK_MODE_UNSELECTED = 0,
@@ -402,11 +402,12 @@ COMMAND_HANDLER(dump_adapter_driver_list)
for (unsigned int i = 0; adapter_drivers[i]; i++) {
const char *name = adapter_drivers[i]->name;
- const char * const *transports = adapter_drivers[i]->transports;
+ unsigned int transport_ids = adapter_drivers[i]->transport_ids;
command_print_sameline(CMD, "%-*s {", max_len, name);
- for (unsigned int j = 0; transports[j]; j++)
- command_print_sameline(CMD, " %s", transports[j]);
+ for (unsigned int j = BIT(0); j & TRANSPORT_VALID_MASK; j <<= 1)
+ if (j & transport_ids)
+ command_print_sameline(CMD, " %s", transport_name(j));
command_print(CMD, " }");
}
@@ -447,7 +448,8 @@ COMMAND_HANDLER(handle_adapter_driver_command)
adapter_driver = adapter_drivers[i];
- return allow_transports(CMD_CTX, adapter_driver->transports);
+ return allow_transports(CMD_CTX, adapter_driver->transport_ids,
+ adapter_driver->transport_preferred_id);
}
/* no valid adapter driver was found (i.e. the configuration option,
diff --git a/src/jtag/drivers/am335xgpio.c b/src/jtag/drivers/am335xgpio.c
index cacf4e7c7..a4727cc89 100644
--- a/src/jtag/drivers/am335xgpio.c
+++ b/src/jtag/drivers/am335xgpio.c
@@ -350,8 +350,6 @@ static const struct command_registration am335xgpio_command_handlers[] = {
COMMAND_REGISTRATION_DONE
};
-static const char * const am335xgpio_transports[] = { "jtag", "swd", NULL };
-
static struct jtag_interface am335xgpio_interface = {
.supported = DEBUG_CAP_TMS_SEQ,
.execute_queue = bitbang_execute_queue,
@@ -494,7 +492,8 @@ static int am335xgpio_quit(void)
struct adapter_driver am335xgpio_adapter_driver = {
.name = "am335xgpio",
- .transports = am335xgpio_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = am335xgpio_command_handlers,
.init = am335xgpio_init,
diff --git a/src/jtag/drivers/amt_jtagaccel.c b/src/jtag/drivers/amt_jtagaccel.c
index 80254ff07..633c20413 100644
--- a/src/jtag/drivers/amt_jtagaccel.c
+++ b/src/jtag/drivers/amt_jtagaccel.c
@@ -579,7 +579,8 @@ static struct jtag_interface amt_jtagaccel_interface = {
struct adapter_driver amt_jtagaccel_adapter_driver = {
.name = "amt_jtagaccel",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = amtjtagaccel_command_handlers,
.init = amt_jtagaccel_init,
diff --git a/src/jtag/drivers/angie.c b/src/jtag/drivers/angie.c
index 46a4c82e5..56a118eae 100644
--- a/src/jtag/drivers/angie.c
+++ b/src/jtag/drivers/angie.c
@@ -2388,7 +2388,8 @@ static struct jtag_interface angie_interface = {
struct adapter_driver angie_adapter_driver = {
.name = "angie",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.init = angie_init,
.quit = angie_quit,
diff --git a/src/jtag/drivers/arm-jtag-ew.c b/src/jtag/drivers/arm-jtag-ew.c
index 45e03840e..9d8c592ed 100644
--- a/src/jtag/drivers/arm-jtag-ew.c
+++ b/src/jtag/drivers/arm-jtag-ew.c
@@ -486,7 +486,8 @@ static struct jtag_interface armjtagew_interface = {
struct adapter_driver armjtagew_adapter_driver = {
.name = "arm-jtag-ew",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = armjtagew_command_handlers,
.init = armjtagew_init,
diff --git a/src/jtag/drivers/at91rm9200.c b/src/jtag/drivers/at91rm9200.c
index a77e29aa6..ddcf857a6 100644
--- a/src/jtag/drivers/at91rm9200.c
+++ b/src/jtag/drivers/at91rm9200.c
@@ -186,7 +186,8 @@ static struct jtag_interface at91rm9200_interface = {
struct adapter_driver at91rm9200_adapter_driver = {
.name = "at91rm9200",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = at91rm9200_command_handlers,
.init = at91rm9200_init,
diff --git a/src/jtag/drivers/bcm2835gpio.c b/src/jtag/drivers/bcm2835gpio.c
index e8689aa03..1a105aac4 100644
--- a/src/jtag/drivers/bcm2835gpio.c
+++ b/src/jtag/drivers/bcm2835gpio.c
@@ -590,15 +590,14 @@ static int bcm2835gpio_quit(void)
}
-static const char * const bcm2835_transports[] = { "jtag", "swd", NULL };
-
static struct jtag_interface bcm2835gpio_interface = {
.supported = DEBUG_CAP_TMS_SEQ,
.execute_queue = bitbang_execute_queue,
};
struct adapter_driver bcm2835gpio_adapter_driver = {
.name = "bcm2835gpio",
- .transports = bcm2835_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = bcm2835gpio_command_handlers,
.init = bcm2835gpio_init,
diff --git a/src/jtag/drivers/buspirate.c b/src/jtag/drivers/buspirate.c
index 93f0ba383..4283616ad 100644
--- a/src/jtag/drivers/buspirate.c
+++ b/src/jtag/drivers/buspirate.c
@@ -534,15 +534,14 @@ static const struct swd_driver buspirate_swd = {
.run = buspirate_swd_run_queue,
};
-static const char * const buspirate_transports[] = { "jtag", "swd", NULL };
-
static struct jtag_interface buspirate_interface = {
.execute_queue = buspirate_execute_queue,
};
struct adapter_driver buspirate_adapter_driver = {
.name = "buspirate",
- .transports = buspirate_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = buspirate_command_handlers,
.init = buspirate_init,
diff --git a/src/jtag/drivers/cmsis_dap.c b/src/jtag/drivers/cmsis_dap.c
index be9ebaed5..2bfcfcc2b 100644
--- a/src/jtag/drivers/cmsis_dap.c
+++ b/src/jtag/drivers/cmsis_dap.c
@@ -2314,8 +2314,6 @@ static const struct swd_driver cmsis_dap_swd_driver = {
.run = cmsis_dap_swd_run_queue,
};
-static const char * const cmsis_dap_transport[] = { "swd", "jtag", NULL };
-
static struct jtag_interface cmsis_dap_interface = {
.supported = DEBUG_CAP_TMS_SEQ,
.execute_queue = cmsis_dap_execute_queue,
@@ -2323,7 +2321,8 @@ static struct jtag_interface cmsis_dap_interface = {
struct adapter_driver cmsis_dap_adapter_driver = {
.name = "cmsis-dap",
- .transports = cmsis_dap_transport,
+ .transport_ids = TRANSPORT_SWD | TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_SWD,
.commands = cmsis_dap_command_handlers,
.init = cmsis_dap_init,
diff --git a/src/jtag/drivers/dmem.c b/src/jtag/drivers/dmem.c
index 4dc582115..e50e84aee 100644
--- a/src/jtag/drivers/dmem.c
+++ b/src/jtag/drivers/dmem.c
@@ -604,11 +604,10 @@ static const struct dap_ops dmem_dap_ops = {
.run = dmem_dp_run,
};
-static const char *const dmem_dap_transport[] = { "dapdirect_swd", NULL };
-
struct adapter_driver dmem_dap_adapter_driver = {
.name = "dmem",
- .transports = dmem_dap_transport,
+ .transport_ids = TRANSPORT_DAPDIRECT_SWD,
+ .transport_preferred_id = TRANSPORT_DAPDIRECT_SWD,
.commands = dmem_dap_command_handlers,
.init = dmem_dap_init,
diff --git a/src/jtag/drivers/dummy.c b/src/jtag/drivers/dummy.c
index 79b29fbae..471668c3a 100644
--- a/src/jtag/drivers/dummy.c
+++ b/src/jtag/drivers/dummy.c
@@ -140,7 +140,8 @@ static struct jtag_interface dummy_interface = {
struct adapter_driver dummy_adapter_driver = {
.name = "dummy",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = dummy_command_handlers,
.init = &dummy_init,
diff --git a/src/jtag/drivers/ep93xx.c b/src/jtag/drivers/ep93xx.c
index ea9faf19b..f3e1676f9 100644
--- a/src/jtag/drivers/ep93xx.c
+++ b/src/jtag/drivers/ep93xx.c
@@ -46,7 +46,8 @@ static struct jtag_interface ep93xx_interface = {
struct adapter_driver ep93xx_adapter_driver = {
.name = "ep93xx",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.init = ep93xx_init,
.quit = ep93xx_quit,
diff --git a/src/jtag/drivers/esp_usb_jtag.c b/src/jtag/drivers/esp_usb_jtag.c
index 950405954..a13303511 100644
--- a/src/jtag/drivers/esp_usb_jtag.c
+++ b/src/jtag/drivers/esp_usb_jtag.c
@@ -784,7 +784,8 @@ static struct jtag_interface esp_usb_jtag_interface = {
struct adapter_driver esp_usb_adapter_driver = {
.name = "esp_usb_jtag",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = esp_usb_jtag_commands,
.init = esp_usb_jtag_init,
diff --git a/src/jtag/drivers/ft232r.c b/src/jtag/drivers/ft232r.c
index f4e5af4dd..f88e4b940 100644
--- a/src/jtag/drivers/ft232r.c
+++ b/src/jtag/drivers/ft232r.c
@@ -900,7 +900,8 @@ static struct jtag_interface ft232r_interface = {
struct adapter_driver ft232r_adapter_driver = {
.name = "ft232r",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = ft232r_command_handlers,
.init = ft232r_init,
diff --git a/src/jtag/drivers/ftdi.c b/src/jtag/drivers/ftdi.c
index ec0ae4c00..a8f6f6015 100644
--- a/src/jtag/drivers/ftdi.c
+++ b/src/jtag/drivers/ftdi.c
@@ -1247,8 +1247,6 @@ static const struct swd_driver ftdi_swd = {
.run = ftdi_swd_run_queue,
};
-static const char * const ftdi_transports[] = { "jtag", "swd", NULL };
-
static struct jtag_interface ftdi_interface = {
.supported = DEBUG_CAP_TMS_SEQ,
.execute_queue = ftdi_execute_queue,
@@ -1256,7 +1254,8 @@ static struct jtag_interface ftdi_interface = {
struct adapter_driver ftdi_adapter_driver = {
.name = "ftdi",
- .transports = ftdi_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = ftdi_command_handlers,
.init = ftdi_initialize,
diff --git a/src/jtag/drivers/gw16012.c b/src/jtag/drivers/gw16012.c
index 7200e757c..805065f1f 100644
--- a/src/jtag/drivers/gw16012.c
+++ b/src/jtag/drivers/gw16012.c
@@ -514,7 +514,8 @@ static struct jtag_interface gw16012_interface = {
struct adapter_driver gw16012_adapter_driver = {
.name = "gw16012",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = gw16012_command_handlers,
.init = gw16012_init,
diff --git a/src/jtag/drivers/imx_gpio.c b/src/jtag/drivers/imx_gpio.c
index 18dc2ddf6..a4a76ca5a 100644
--- a/src/jtag/drivers/imx_gpio.c
+++ b/src/jtag/drivers/imx_gpio.c
@@ -417,8 +417,6 @@ static const struct command_registration imx_gpio_command_handlers[] = {
COMMAND_REGISTRATION_DONE
};
-static const char * const imx_gpio_transports[] = { "jtag", "swd", NULL };
-
static struct jtag_interface imx_gpio_interface = {
.supported = DEBUG_CAP_TMS_SEQ,
.execute_queue = bitbang_execute_queue,
@@ -426,7 +424,8 @@ static struct jtag_interface imx_gpio_interface = {
struct adapter_driver imx_gpio_adapter_driver = {
.name = "imx_gpio",
- .transports = imx_gpio_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = imx_gpio_command_handlers,
.init = imx_gpio_init,
diff --git a/src/jtag/drivers/jlink.c b/src/jtag/drivers/jlink.c
index 4d15cf5e6..9caf37f6f 100644
--- a/src/jtag/drivers/jlink.c
+++ b/src/jtag/drivers/jlink.c
@@ -2264,15 +2264,14 @@ static const struct swd_driver jlink_swd = {
.run = &jlink_swd_run_queue,
};
-static const char * const jlink_transports[] = { "jtag", "swd", NULL };
-
static struct jtag_interface jlink_interface = {
.execute_queue = &jlink_execute_queue,
};
struct adapter_driver jlink_adapter_driver = {
.name = "jlink",
- .transports = jlink_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = jlink_command_handlers,
.init = &jlink_init,
diff --git a/src/jtag/drivers/jtag_dpi.c b/src/jtag/drivers/jtag_dpi.c
index 046186a61..d6418d39c 100644
--- a/src/jtag/drivers/jtag_dpi.c
+++ b/src/jtag/drivers/jtag_dpi.c
@@ -398,7 +398,8 @@ static struct jtag_interface jtag_dpi_interface = {
struct adapter_driver jtag_dpi_adapter_driver = {
.name = "jtag_dpi",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = jtag_dpi_command_handlers,
.init = jtag_dpi_init,
.quit = jtag_dpi_quit,
diff --git a/src/jtag/drivers/jtag_vpi.c b/src/jtag/drivers/jtag_vpi.c
index f6cb3de5d..fac27b306 100644
--- a/src/jtag/drivers/jtag_vpi.c
+++ b/src/jtag/drivers/jtag_vpi.c
@@ -666,7 +666,8 @@ static struct jtag_interface jtag_vpi_interface = {
struct adapter_driver jtag_vpi_adapter_driver = {
.name = "jtag_vpi",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = jtag_vpi_command_handlers,
.init = jtag_vpi_init,
diff --git a/src/jtag/drivers/kitprog.c b/src/jtag/drivers/kitprog.c
index 98b0d1668..88e301ceb 100644
--- a/src/jtag/drivers/kitprog.c
+++ b/src/jtag/drivers/kitprog.c
@@ -908,11 +908,10 @@ static const struct swd_driver kitprog_swd = {
.run = kitprog_swd_run_queue,
};
-static const char * const kitprog_transports[] = { "swd", NULL };
-
struct adapter_driver kitprog_adapter_driver = {
.name = "kitprog",
- .transports = kitprog_transports,
+ .transport_ids = TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_SWD,
.commands = kitprog_command_handlers,
.init = kitprog_init,
diff --git a/src/jtag/drivers/linuxgpiod.c b/src/jtag/drivers/linuxgpiod.c
index eda7b1a80..36c7e0493 100644
--- a/src/jtag/drivers/linuxgpiod.c
+++ b/src/jtag/drivers/linuxgpiod.c
@@ -425,8 +425,6 @@ out_error:
return ERROR_JTAG_INIT_FAILED;
}
-static const char *const linuxgpiod_transport[] = { "swd", "jtag", NULL };
-
static struct jtag_interface linuxgpiod_interface = {
.supported = DEBUG_CAP_TMS_SEQ,
.execute_queue = bitbang_execute_queue,
@@ -434,7 +432,8 @@ static struct jtag_interface linuxgpiod_interface = {
struct adapter_driver linuxgpiod_adapter_driver = {
.name = "linuxgpiod",
- .transports = linuxgpiod_transport,
+ .transport_ids = TRANSPORT_SWD | TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_SWD,
.init = linuxgpiod_init,
.quit = linuxgpiod_quit,
diff --git a/src/jtag/drivers/linuxspidev.c b/src/jtag/drivers/linuxspidev.c
index 18abdc7db..396f1a19a 100644
--- a/src/jtag/drivers/linuxspidev.c
+++ b/src/jtag/drivers/linuxspidev.c
@@ -616,12 +616,10 @@ static const struct command_registration spidev_command_handlers[] = {
COMMAND_REGISTRATION_DONE
};
-// Only SWD transport supported
-static const char *const spidev_transports[] = { "swd", NULL };
-
struct adapter_driver linuxspidev_adapter_driver = {
.name = "linuxspidev",
- .transports = spidev_transports,
+ .transport_ids = TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_SWD,
.commands = spidev_command_handlers,
.init = spidev_init,
diff --git a/src/jtag/drivers/opendous.c b/src/jtag/drivers/opendous.c
index 999afb3fc..04626cb1e 100644
--- a/src/jtag/drivers/opendous.c
+++ b/src/jtag/drivers/opendous.c
@@ -229,7 +229,8 @@ static struct jtag_interface opendous_interface = {
struct adapter_driver opendous_adapter_driver = {
.name = "opendous",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = opendous_command_handlers,
.init = opendous_init,
diff --git a/src/jtag/drivers/openjtag.c b/src/jtag/drivers/openjtag.c
index 14bcc171e..943ad854e 100644
--- a/src/jtag/drivers/openjtag.c
+++ b/src/jtag/drivers/openjtag.c
@@ -931,7 +931,8 @@ static struct jtag_interface openjtag_interface = {
struct adapter_driver openjtag_adapter_driver = {
.name = "openjtag",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = openjtag_command_handlers,
.init = openjtag_init,
diff --git a/src/jtag/drivers/osbdm.c b/src/jtag/drivers/osbdm.c
index 80f66d197..de2e1f8eb 100644
--- a/src/jtag/drivers/osbdm.c
+++ b/src/jtag/drivers/osbdm.c
@@ -684,7 +684,8 @@ static struct jtag_interface osbdm_interface = {
struct adapter_driver osbdm_adapter_driver = {
.name = "osbdm",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.init = osbdm_init,
.quit = osbdm_quit,
diff --git a/src/jtag/drivers/parport.c b/src/jtag/drivers/parport.c
index 3b20fe247..143f3bde1 100644
--- a/src/jtag/drivers/parport.c
+++ b/src/jtag/drivers/parport.c
@@ -533,7 +533,8 @@ static struct jtag_interface parport_interface = {
struct adapter_driver parport_adapter_driver = {
.name = "parport",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = parport_command_handlers,
.init = parport_init,
diff --git a/src/jtag/drivers/presto.c b/src/jtag/drivers/presto.c
index f6e13f7eb..84b881cdc 100644
--- a/src/jtag/drivers/presto.c
+++ b/src/jtag/drivers/presto.c
@@ -528,7 +528,8 @@ static struct jtag_interface presto_interface = {
struct adapter_driver presto_adapter_driver = {
.name = "presto",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.init = presto_jtag_init,
.quit = presto_jtag_quit,
diff --git a/src/jtag/drivers/remote_bitbang.c b/src/jtag/drivers/remote_bitbang.c
index bb608ba0a..449c61654 100644
--- a/src/jtag/drivers/remote_bitbang.c
+++ b/src/jtag/drivers/remote_bitbang.c
@@ -412,8 +412,6 @@ COMMAND_HANDLER(remote_bitbang_handle_remote_bitbang_host_command)
return ERROR_COMMAND_SYNTAX_ERROR;
}
-static const char * const remote_bitbang_transports[] = { "jtag", "swd", NULL };
-
COMMAND_HANDLER(remote_bitbang_handle_remote_bitbang_use_remote_sleep_command)
{
if (CMD_ARGC != 1)
@@ -484,7 +482,8 @@ static struct jtag_interface remote_bitbang_interface = {
struct adapter_driver remote_bitbang_adapter_driver = {
.name = "remote_bitbang",
- .transports = remote_bitbang_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = remote_bitbang_command_handlers,
.init = &remote_bitbang_init,
diff --git a/src/jtag/drivers/rlink.c b/src/jtag/drivers/rlink.c
index 6ea3729a5..a81899625 100644
--- a/src/jtag/drivers/rlink.c
+++ b/src/jtag/drivers/rlink.c
@@ -1675,7 +1675,8 @@ static struct jtag_interface rlink_interface = {
struct adapter_driver rlink_adapter_driver = {
.name = "rlink",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.init = rlink_init,
.quit = rlink_quit,
diff --git a/src/jtag/drivers/rshim.c b/src/jtag/drivers/rshim.c
index b37fe8c45..89bdadd69 100644
--- a/src/jtag/drivers/rshim.c
+++ b/src/jtag/drivers/rshim.c
@@ -508,11 +508,10 @@ static const struct dap_ops rshim_dap_ops = {
.quit = rshim_disconnect,
};
-static const char *const rshim_dap_transport[] = { "dapdirect_swd", NULL };
-
struct adapter_driver rshim_dap_adapter_driver = {
.name = "rshim",
- .transports = rshim_dap_transport,
+ .transport_ids = TRANSPORT_DAPDIRECT_SWD,
+ .transport_preferred_id = TRANSPORT_DAPDIRECT_SWD,
.commands = rshim_dap_command_handlers,
.init = rshim_dap_init,
diff --git a/src/jtag/drivers/stlink_usb.c b/src/jtag/drivers/stlink_usb.c
index d77f28b0f..e018f71cd 100644
--- a/src/jtag/drivers/stlink_usb.c
+++ b/src/jtag/drivers/stlink_usb.c
@@ -5217,11 +5217,10 @@ static const struct swim_driver stlink_swim_ops = {
.reconnect = stlink_swim_op_reconnect,
};
-static const char *const stlink_dap_transport[] = { "dapdirect_swd", "dapdirect_jtag", "swim", NULL };
-
struct adapter_driver stlink_dap_adapter_driver = {
.name = "st-link",
- .transports = stlink_dap_transport,
+ .transport_ids = TRANSPORT_DAPDIRECT_SWD | TRANSPORT_DAPDIRECT_JTAG | TRANSPORT_SWIM,
+ .transport_preferred_id = TRANSPORT_DAPDIRECT_SWD,
.commands = stlink_dap_command_handlers,
.init = stlink_dap_init,
diff --git a/src/jtag/drivers/sysfsgpio.c b/src/jtag/drivers/sysfsgpio.c
index ccd3974a4..279b35377 100644
--- a/src/jtag/drivers/sysfsgpio.c
+++ b/src/jtag/drivers/sysfsgpio.c
@@ -545,8 +545,6 @@ static const struct command_registration sysfsgpio_command_handlers[] = {
static int sysfsgpio_init(void);
static int sysfsgpio_quit(void);
-static const char * const sysfsgpio_transports[] = { "jtag", "swd", NULL };
-
static struct jtag_interface sysfsgpio_interface = {
.supported = DEBUG_CAP_TMS_SEQ,
.execute_queue = bitbang_execute_queue,
@@ -554,7 +552,8 @@ static struct jtag_interface sysfsgpio_interface = {
struct adapter_driver sysfsgpio_adapter_driver = {
.name = "sysfsgpio",
- .transports = sysfsgpio_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = sysfsgpio_command_handlers,
.init = sysfsgpio_init,
diff --git a/src/jtag/drivers/ulink.c b/src/jtag/drivers/ulink.c
index 0a13bf6d4..417d560cd 100644
--- a/src/jtag/drivers/ulink.c
+++ b/src/jtag/drivers/ulink.c
@@ -2271,7 +2271,8 @@ static struct jtag_interface ulink_interface = {
struct adapter_driver ulink_adapter_driver = {
.name = "ulink",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = ulink_command_handlers,
.init = ulink_init,
diff --git a/src/jtag/drivers/usb_blaster/usb_blaster.c b/src/jtag/drivers/usb_blaster/usb_blaster.c
index 1782cc424..81344664e 100644
--- a/src/jtag/drivers/usb_blaster/usb_blaster.c
+++ b/src/jtag/drivers/usb_blaster/usb_blaster.c
@@ -1057,7 +1057,8 @@ static struct jtag_interface usb_blaster_interface = {
struct adapter_driver usb_blaster_adapter_driver = {
.name = "usb_blaster",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = ublast_command_handlers,
.init = ublast_init,
diff --git a/src/jtag/drivers/usbprog.c b/src/jtag/drivers/usbprog.c
index 24407f003..264b45f72 100644
--- a/src/jtag/drivers/usbprog.c
+++ b/src/jtag/drivers/usbprog.c
@@ -590,7 +590,8 @@ static struct jtag_interface usbprog_interface = {
struct adapter_driver usbprog_adapter_driver = {
.name = "usbprog",
- .transports = jtag_only,
+ .transport_ids = TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_JTAG,
.init = usbprog_init,
.quit = usbprog_quit,
diff --git a/src/jtag/drivers/vdebug.c b/src/jtag/drivers/vdebug.c
index fd1e6a7e7..38685950a 100644
--- a/src/jtag/drivers/vdebug.c
+++ b/src/jtag/drivers/vdebug.c
@@ -1342,11 +1342,10 @@ static const struct dap_ops vdebug_dap_ops = {
.quit = NULL, /* optional */
};
-static const char *const vdebug_transports[] = { "jtag", "dapdirect_swd", NULL };
-
struct adapter_driver vdebug_adapter_driver = {
.name = "vdebug",
- .transports = vdebug_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_DAPDIRECT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.speed = vdebug_jtag_speed,
.khz = vdebug_jtag_khz,
.speed_div = vdebug_jtag_div,
diff --git a/src/jtag/drivers/vsllink.c b/src/jtag/drivers/vsllink.c
index c10ed1380..145f0682a 100644
--- a/src/jtag/drivers/vsllink.c
+++ b/src/jtag/drivers/vsllink.c
@@ -913,8 +913,6 @@ static const struct command_registration vsllink_command_handlers[] = {
COMMAND_REGISTRATION_DONE
};
-static const char * const vsllink_transports[] = {"jtag", "swd", NULL};
-
static const struct swd_driver vsllink_swd_driver = {
.init = vsllink_swd_init,
.switch_seq = vsllink_swd_switch_seq,
@@ -930,7 +928,8 @@ static struct jtag_interface vsllink_interface = {
struct adapter_driver vsllink_adapter_driver = {
.name = "vsllink",
- .transports = vsllink_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = vsllink_command_handlers,
.init = vsllink_init,
diff --git a/src/jtag/drivers/xds110.c b/src/jtag/drivers/xds110.c
index c84371001..d1bb70590 100644
--- a/src/jtag/drivers/xds110.c
+++ b/src/jtag/drivers/xds110.c
@@ -2058,15 +2058,14 @@ static const struct swd_driver xds110_swd_driver = {
.run = xds110_swd_run_queue,
};
-static const char * const xds110_transport[] = { "swd", "jtag", NULL };
-
static struct jtag_interface xds110_interface = {
.execute_queue = xds110_execute_queue,
};
struct adapter_driver xds110_adapter_driver = {
.name = "xds110",
- .transports = xds110_transport,
+ .transport_ids = TRANSPORT_SWD | TRANSPORT_JTAG,
+ .transport_preferred_id = TRANSPORT_SWD,
.commands = xds110_command_handlers,
.init = xds110_init,
diff --git a/src/jtag/drivers/xlnx-pcie-xvc.c b/src/jtag/drivers/xlnx-pcie-xvc.c
index 37c6777e4..3baa183d9 100644
--- a/src/jtag/drivers/xlnx-pcie-xvc.c
+++ b/src/jtag/drivers/xlnx-pcie-xvc.c
@@ -690,11 +690,10 @@ static const struct swd_driver xlnx_pcie_xvc_swd_ops = {
.run = xlnx_pcie_xvc_swd_run_queue,
};
-static const char * const xlnx_pcie_xvc_transports[] = { "jtag", "swd", NULL };
-
struct adapter_driver xlnx_pcie_xvc_adapter_driver = {
.name = "xlnx_pcie_xvc",
- .transports = xlnx_pcie_xvc_transports,
+ .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
+ .transport_preferred_id = TRANSPORT_JTAG,
.commands = xlnx_pcie_xvc_command_handlers,
.init = &xlnx_pcie_xvc_init,
diff --git a/src/jtag/hla/hla_interface.c b/src/jtag/hla/hla_interface.c
index 96862b0d0..a9d196cce 100644
--- a/src/jtag/hla/hla_interface.c
+++ b/src/jtag/hla/hla_interface.c
@@ -367,7 +367,8 @@ static const struct command_registration hl_interface_command_handlers[] = {
struct adapter_driver hl_adapter_driver = {
.name = "hla",
- .transports = hl_transports,
+ .transport_ids = TRANSPORT_HLA_SWD | TRANSPORT_HLA_JTAG,
+ .transport_preferred_id = TRANSPORT_HLA_SWD,
.commands = hl_interface_command_handlers,
.init = hl_interface_init,
diff --git a/src/jtag/hla/hla_interface.h b/src/jtag/hla/hla_interface.h
index f1550d991..c0ee05498 100644
--- a/src/jtag/hla/hla_interface.h
+++ b/src/jtag/hla/hla_interface.h
@@ -15,8 +15,6 @@
struct target;
/** */
enum e_hl_transports;
-/** */
-extern const char *hl_transports[];
#define HLA_MAX_USB_IDS 16
diff --git a/src/jtag/hla/hla_transport.c b/src/jtag/hla/hla_transport.c
index 333825eff..d8ece0776 100644
--- a/src/jtag/hla/hla_transport.c
+++ b/src/jtag/hla/hla_transport.c
@@ -231,8 +231,6 @@ static struct transport hl_jtag_transport = {
.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)
{
diff --git a/src/jtag/interface.h b/src/jtag/interface.h
index b2d7123fd..475dbed36 100644
--- a/src/jtag/interface.h
+++ b/src/jtag/interface.h
@@ -17,6 +17,7 @@
#include <jtag/jtag.h>
#include <jtag/swim.h>
#include <target/arm_tpiu_swo.h>
+#include <transport/transport.h>
/* @file
* The "Cable Helper API" is what the cable drivers can use to help
@@ -208,8 +209,16 @@ struct adapter_driver {
/** The name of the interface driver. */
const char * const name;
- /** transports supported in C code (NULL terminated vector) */
- const char * const *transports;
+ /**
+ * Bitmask of transport IDs supported in C code.
+ */
+ unsigned int transport_ids;
+
+ /**
+ * ID of transport that gets auto-selected when not specified by the user.
+ * The auto-selection of transport is DEPRECATED.
+ */
+ unsigned int transport_preferred_id;
/**
* The interface driver may register additional commands to expose
@@ -354,8 +363,6 @@ struct adapter_driver {
const struct swim_driver *swim_ops;
};
-extern const char * const jtag_only[];
-
int adapter_resets(int assert_trst, int assert_srst);
int adapter_assert_reset(void);
int adapter_deassert_reset(void);
diff --git a/src/transport/transport.c b/src/transport/transport.c
index 411b0a5e0..b7a3913cc 100644
--- a/src/transport/transport.c
+++ b/src/transport/transport.c
@@ -62,11 +62,15 @@ static const struct {
static struct transport *transport_list;
/**
- * NULL-terminated Vector of names of transports which the
- * currently selected debug adapter supports. This is declared
- * by the time that adapter is fully set up.
+ * Bitmask of transport IDs which the currently selected debug adapter supports.
+ * This is declared by the time that adapter is fully set up.
*/
-static const char * const *allowed_transports;
+static unsigned int allowed_transports;
+
+/**
+ * Transport ID auto-selected when not specified by the user.
+ */
+static unsigned int preferred_transport;
/**
* Adapter supports a single transport; it has been auto-selected
@@ -76,7 +80,7 @@ static bool transport_single_is_autoselected;
/** * The transport being used for the current OpenOCD session. */
static struct transport *session;
-static const char *transport_name(unsigned int id)
+const char *transport_name(unsigned int id)
{
for (unsigned int i = 0; i < ARRAY_SIZE(transport_names); i++)
if (id == transport_names[i].id)
@@ -118,13 +122,14 @@ static int transport_select(struct command_context *ctx, const char *name)
* to declare the set of transports supported by an adapter. When
* there is only one member of that set, it is automatically selected.
*/
-int allow_transports(struct command_context *ctx, const char * const *vector)
+int allow_transports(struct command_context *ctx, unsigned int transport_ids,
+ unsigned int transport_preferred_id)
{
/* NOTE: caller is required to provide only a list
- * of *valid* transport names
+ * of *valid* transports
*
* REVISIT should we validate that? and insist there's
- * at least one non-NULL element in that list?
+ * at least one valid element in that list?
*
* ... allow removals, e.g. external strapping prevents use
* of one transport; C code should be definitive about what
@@ -135,13 +140,14 @@ int allow_transports(struct command_context *ctx, const char * const *vector)
return ERROR_FAIL;
}
- allowed_transports = vector;
+ allowed_transports = transport_ids;
+ preferred_transport = transport_preferred_id;
/* autoselect if there's no choice ... */
- if (!vector[1]) {
- LOG_DEBUG("only one transport option; autoselecting '%s'", vector[0]);
+ if (IS_PWR_OF_2(transport_ids)) {
+ LOG_DEBUG("only one transport option; autoselecting '%s'", transport_name(transport_ids));
transport_single_is_autoselected = true;
- return transport_select(ctx, vector[0]);
+ return transport_select(ctx, transport_name(transport_ids));
}
return ERROR_OK;
@@ -226,10 +232,9 @@ COMMAND_HANDLER(handle_transport_init)
/* no session transport configured, print transports then fail */
LOG_ERROR("Transports available:");
- const char * const *vector = allowed_transports;
- while (*vector) {
- LOG_ERROR("%s", *vector);
- vector++;
+ for (unsigned int i = BIT(0); i & TRANSPORT_VALID_MASK; i <<= 1) {
+ if (i & allowed_transports)
+ LOG_ERROR("%s", transport_name(i));
}
return ERROR_FAIL;
}
@@ -275,8 +280,9 @@ COMMAND_HANDLER(handle_transport_select)
}
LOG_WARNING("DEPRECATED: auto-selecting transport \"%s\". "
"Use 'transport select %s' to suppress this message.",
- allowed_transports[0], allowed_transports[0]);
- int retval = transport_select(CMD_CTX, allowed_transports[0]);
+ transport_name(preferred_transport),
+ transport_name(preferred_transport));
+ int retval = transport_select(CMD_CTX, transport_name(preferred_transport));
if (retval != ERROR_OK)
return retval;
}
@@ -310,8 +316,9 @@ COMMAND_HANDLER(handle_transport_select)
return ERROR_FAIL;
}
- for (unsigned int i = 0; allowed_transports[i]; i++) {
- if (!strcmp(allowed_transports[i], CMD_ARGV[0])) {
+ for (unsigned int i = BIT(0); i & TRANSPORT_VALID_MASK; i <<= 1) {
+ if ((i & allowed_transports)
+ && !strcmp(transport_name(i), CMD_ARGV[0])) {
int retval = transport_select(CMD_CTX, CMD_ARGV[0]);
if (retval != ERROR_OK)
return retval;
diff --git a/src/transport/transport.h b/src/transport/transport.h
index dde7c6ba7..f6f0f4f4d 100644
--- a/src/transport/transport.h
+++ b/src/transport/transport.h
@@ -95,9 +95,12 @@ struct transport *get_current_transport(void);
const char *get_current_transport_name(void);
+const char *transport_name(unsigned int id);
+
int transport_register_commands(struct command_context *ctx);
-int allow_transports(struct command_context *ctx, const char * const *vector);
+int allow_transports(struct command_context *ctx, unsigned int transport_ids,
+ unsigned int transport_preferred_id);
bool transport_is_jtag(void);
bool transport_is_swd(void);
commit 236208a5ff2db5f502444b32da1df3fd17b692fb
Author: Antonio Borneo <bor...@gm...>
Date: Sun Dec 22 17:06:12 2024 +0100
transport: use a bitmask for the transport
Move the transport's names in a local array in the transport
framework.
Replace the string struct transport::name, that identifies the
transport, with a bitmask where each bit corresponds to one of the
available transports.
Change-Id: I6bdf7264d5979c355299f63fcf80bf54dcd95cee
Signed-off-by: Antonio Borneo <bor...@gm...>
Reviewed-on: https://review.openocd.org/c/openocd/+/8674
Tested-by: jenkins
Reviewed-by: zapb <de...@za...>
diff --git a/src/jtag/core.c b/src/jtag/core.c
index 030c173be..6dd2144c6 100644
--- a/src/jtag/core.c
+++ b/src/jtag/core.c
@@ -1823,7 +1823,7 @@ static int jtag_select(struct command_context *ctx)
}
static struct transport jtag_transport = {
- .name = "jtag",
+ .id = TRANSPORT_JTAG,
.select = jtag_select,
.init = jtag_init,
};
@@ -1868,7 +1868,7 @@ int adapter_resets(int trst, int srst)
transport_is_swim()) {
if (trst == TRST_ASSERT) {
LOG_ERROR("transport %s has no trst signal",
- get_current_transport()->name);
+ get_current_transport_name());
return ERROR_FAIL;
}
@@ -1884,7 +1884,7 @@ int adapter_resets(int trst, int srst)
return ERROR_OK;
LOG_ERROR("reset is not supported on transport %s",
- get_current_transport()->name);
+ get_current_transport_name());
return ERROR_FAIL;
}
@@ -1903,7 +1903,7 @@ int adapter_assert_reset(void)
return adapter_system_reset(1);
else if (get_current_transport())
LOG_ERROR("reset is not supported on %s",
- get_current_transport()->name);
+ get_current_transport_name());
else
LOG_ERROR("transport is not selected");
return ERROR_FAIL;
@@ -1920,7 +1920,7 @@ int adapter_deassert_reset(void)
return adapter_system_reset(0);
else if (get_current_transport())
LOG_ERROR("reset is not supported on %s",
- get_current_transport()->name);
+ get_current_transport_name());
else
LOG_ERROR("transport is not selected");
return ERROR_FAIL;
diff --git a/src/jtag/hla/hla_transport.c b/src/jtag/hla/hla_transport.c
index b826eb0fe..333825eff 100644
--- a/src/jtag/hla/hla_transport.c
+++ b/src/jtag/hla/hla_transport.c
@@ -177,15 +177,20 @@ static int hl_transport_init(struct command_context *cmd_ctx)
return ERROR_FAIL;
}
- LOG_DEBUG("current transport %s", transport->name);
+ LOG_DEBUG("current transport %s", get_current_transport_name());
/* get selected transport as enum */
- tr = HL_TRANSPORT_UNKNOWN;
-
- if (strcmp(transport->name, "hla_swd") == 0)
+ switch (transport->id) {
+ case TRANSPORT_HLA_SWD:
tr = HL_TRANSPORT_SWD;
- else if (strcmp(transport->name, "hla_jtag") == 0)
+ break;
+ case TRANSPORT_HLA_JTAG:
tr = HL_TRANSPORT_JTAG;
+ break;
+ default:
+ tr = HL_TRANSPORT_UNKNOWN;
+ break;
+ }
int retval = hl_interface_open(tr);
@@ -213,14 +218,14 @@ static int hl_swd_transport_select(struct command_context *cmd_ctx)
}
static struct transport hl_swd_transport = {
- .name = "hla_swd",
+ .id = TRANSPORT_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",
+ .id = TRANSPORT_HLA_JTAG,
.select = hl_jtag_transport_select,
.init = hl_transport_init,
.override_target = hl_interface_override_target,
diff --git a/src/jtag/swim.c b/src/jtag/swim.c
index de3e106a1..004a9fd4f 100644
--- a/src/jtag/swim.c
+++ b/src/jtag/swim.c
@@ -136,7 +136,7 @@ static int swim_transport_init(struct command_context *cmd_ctx)
}
static struct transport swim_transport = {
- .name = "swim",
+ .id = TRANSPORT_SWIM,
.select = swim_transport_select,
.init = swim_transport_init,
};
diff --git a/src/target/adi_v5_dapdirect.c b/src/target/adi_v5_dapdirect.c
index d198dacf3..07ea313d1 100644
--- a/src/target/adi_v5_dapdirect.c
+++ b/src/target/adi_v5_dapdirect.c
@@ -207,13 +207,13 @@ static int dapdirect_init(struct command_context *ctx)
}
static struct transport dapdirect_jtag_transport = {
- .name = "dapdirect_jtag",
+ .id = TRANSPORT_DAPDIRECT_JTAG,
.select = dapdirect_jtag_select,
.init = dapdirect_init,
};
static struct transport dapdirect_swd_transport = {
- .name = "dapdirect_swd",
+ .id = TRANSPORT_DAPDIRECT_SWD,
.select = dapdirect_swd_select,
.init = dapdirect_init,
};
diff --git a/src/target/adi_v5_swd.c b/src/target/adi_v5_swd.c
index e50f8f137..2d286136a 100644
--- a/src/target/adi_v5_swd.c
+++ b/src/target/adi_v5_swd.c
@@ -756,7 +756,7 @@ static int swd_init(struct command_context *ctx)
}
static struct transport swd_transport = {
- .name = "swd",
+ .id = TRANSPORT_SWD,
.select = swd_select,
.init = swd_init,
};
diff --git a/src/transport/transport.c b/src/transport/transport.c
index 4a1f71d40..411b0a5e0 100644
--- a/src/transport/transport.c
+++ b/src/transport/transport.c
@@ -30,6 +30,8 @@
* messaging and error handling.
*/
+#include <helper/align.h>
+#include <helper/bits.h>
#include <helper/log.h>
#include <helper/replacements.h>
#include <transport/transport.h>
@@ -43,6 +45,20 @@ extern struct command_context *global_cmd_ctx;
*/
/** List of transports known to OpenOCD. */
+static const struct {
+ unsigned int id;
+ const char *name;
+} transport_names[] = {
+ { TRANSPORT_JTAG, "jtag", },
+ { TRANSPORT_SWD, "swd", },
+ { TRANSPORT_HLA_JTAG, "hla_jtag", },
+ { TRANSPORT_HLA_SWD, "hla_swd", },
+ { TRANSPORT_DAPDIRECT_JTAG, "dapdirect_jtag", },
+ { TRANSPORT_DAPDIRECT_SWD, "dapdirect_swd", },
+ { TRANSPORT_SWIM, "swim", },
+};
+
+/** List of transports registered in OpenOCD. */
static struct transport *transport_list;
/**
@@ -60,12 +76,26 @@ static bool transport_single_is_autoselected;
/** * The transport being used for the current OpenOCD session. */
static struct transport *session;
+static const char *transport_name(unsigned int id)
+{
+ for (unsigned int i = 0; i < ARRAY_SIZE(transport_names); i++)
+ if (id == transport_names[i].id)
+ return transport_names[i].name;
+
+ return NULL;
+}
+
+static bool is_transport_id_valid(unsigned int id)
+{
+ return (id != 0) && ((id & ~TRANSPORT_VALID_MASK) == 0) && IS_PWR_OF_2(id);
+}
+
static int transport_select(struct command_context *ctx, const char *name)
{
/* name may only identify a known transport;
* caller guarantees session's transport isn't yet set.*/
for (struct transport *t = transport_list; t; t = t->next) {
- if (strcmp(t->name, name) == 0) {
+ if (!strcmp(transport_name(t->id), name)) {
int retval = t->select(ctx);
/* select() registers commands specific to this
* transport, and may also reset the link, e.g.
@@ -74,7 +104,7 @@ static int transport_select(struct command_context *ctx, const char *name)
if (retval == ERROR_OK)
session = t;
else
- LOG_ERROR("Error selecting '%s' as transport", t->name);
+ LOG_ERROR("Error selecting '%s' as transport", name);
return retval;
}
}
@@ -136,20 +166,28 @@ int transport_register(struct transport *new_transport)
{
struct transport *t;
+ if (!is_transport_id_valid(new_transport->id)) {
+ LOG_ERROR("invalid transport ID 0x%x", new_transport->id);
+ return ERROR_FAIL;
+ }
+
for (t = transport_list; t; t = t->next) {
- if (strcmp(t->name, new_transport->name) == 0) {
- LOG_ERROR("transport name already used");
+ if (t->id == new_transport->id) {
+ LOG_ERROR("transport '%s' already registered",
+ transport_name(t->id));
return ERROR_FAIL;
}
}
if (!new_transport->select || !new_transport->init)
- LOG_ERROR("invalid transport %s", new_transport->name);
+ LOG_ERROR("invalid transport %s",
+ transport_name(new_transport->id));
/* splice this into the list */
new_transport->next = transport_list;
transport_list = new_transport;
- LOG_DEBUG("register '%s'", new_transport->name);
+ LOG_DEBUG("register '%s' (ID %d)",
+ transport_name(new_transport->id), new_transport->id);
return ERROR_OK;
}
@@ -166,6 +204,14 @@ struct transport *get_current_transport(void)
return session;
}
+const char *get_current_transport_name(void)
+{
+ if (!session || !is_transport_id_valid(session->id))
+ NULL;
+
+ return transport_name(session->id);
+}
+
/*-----------------------------------------------------------------------*/
/*
@@ -191,7 +237,7 @@ COMMAND_HANDLER(handle_transport_init)
if (transport_single_is_autoselected)
LOG_WARNING("DEPRECATED: auto-selecting transport \"%s\". "
"Use 'transport select %s' to suppress this message.",
- session->name, session->name);
+ transport_name(session->id), transport_name(session->id));
return session->init(CMD_CTX);
}
@@ -204,7 +250,7 @@ COMMAND_HANDLER(handle_transport_list)
command_print(CMD, "The following transports are available:");
for (struct transport *t = transport_list; t; t = t->next)
- command_print(CMD, "\t%s", t->name);
+ command_print(CMD, "\t%s", transport_name(t->id));
return ERROR_OK;
}
@@ -234,19 +280,19 @@ COMMAND_HANDLER(handle_transport_select)
if (retval != ERROR_OK)
return retval;
}
- command_print(CMD, "%s", session->name);
+ command_print(CMD, "%s", transport_name(session->id));
return ERROR_OK;
}
/* assign transport */
if (session) {
- if (!strcmp(session->name, CMD_ARGV[0])) {
+ if (!strcmp(transport_name(session->id), CMD_ARGV[0])) {
if (transport_single_is_autoselected) {
/* Nothing to do, but also nothing to complain */
transport_single_is_autoselected = false;
return ERROR_OK;
}
- LOG_WARNING("Transport \"%s\" was already selected", session->name);
+ LOG_WARNING("Transport \"%s\" was already selected", CMD_ARGV[0]);
return ERROR_OK;
}
command_print(CMD, "Can't change session's transport after the initial selection was made");
diff --git a/src/transport/transport.h b/src/transport/transport.h
index 2e3dcc61a..dde7c6ba7 100644
--- a/src/transport/transport.h
+++ b/src/transport/transport.h
@@ -12,8 +12,27 @@
#include "config.h"
#endif
+#include "helper/bits.h"
#include "helper/command.h"
+#define TRANSPORT_JTAG BIT(0)
+#define TRANSPORT_SWD BIT(1)
+#define TRANSPORT_HLA_JTAG BIT(2)
+#define TRANSPORT_HLA_SWD BIT(3)
+#define TRANSPORT_DAPDIRECT_JTAG BIT(4)
+#define TRANSPORT_DAPDIRECT_SWD BIT(5)
+#define TRANSPORT_SWIM BIT(6)
+
+/* mask for valid ID */
+#define TRANSPORT_VALID_MASK \
+ (TRANSPORT_JTAG | \
+ TRANSPORT_SWD | \
+ TRANSPORT_HLA_JTAG | \
+ TRANSPORT_HLA_SWD | \
+ TRANSPORT_DAPDIRECT_JTAG | \
+ TRANSPORT_DAPDIRECT_SWD | \
+ TRANSPORT_SWIM)
+
/**
* Wrapper for transport lifecycle operations.
*
@@ -34,11 +53,10 @@
*/
struct transport {
/**
- * Each transport has a unique name, used to select it
- * from among the alternatives. Examples might include
- * "jtag", * "swd", "AVR_ISP" and more.
+ * Each transport has a unique ID, used to select it
+ * from among the alternatives.
*/
- const char *name;
+ unsigned int id;
/**
* When a transport is selected, this method registers
@@ -75,6 +93,8 @@ int transport_register(struct transport *new_transport);
struct transport *get_current_transport(void);
+const char *get_current_transport_name(void);
+
int transport_register_commands(struct command_context *ctx);
int allow_transports(struct command_context *ctx, const char * const *vector);
commit 9a5de74423503d1bd16e16b77b4e0e6d19913057
Author: Antonio Borneo <bor...@gm...>
Date: Sat Jan 4 16:54:14 2025 +0100
transport: deprecate auto-selection of transport
Historically, if the user does not specify a transport, OpenOCD
select automatically the first transport listed in the adapter
driver.
This auto-selection can behave differently by changing adapter,
so the transport should be enforced in the configuration file.
Deprecate the auto-selection and print a warning message when a
transport gets auto-selected.
There are two cases:
- adapter offers one transport only. The code early auto-selects
the transport but does not print anything. If later the user
selects the transport then no deprecation will be printed during
'transport init';
- user runs 'transport select', e.g. in 'swj-dp' script, and this
triggers the auto-selection and the deprecated message.
Change-Id: I2e55b9dcc6da77ca937978fbfb36bc365b803f0d
Signed-off-by: Antonio Borneo <bor...@gm...>
Reviewed-on: https://review.openocd.org/c/openocd/+/8692
Reviewed-by: Jan Matyas <jan...@co...>
Reviewed-by: zapb <de...@za...>
Tested-by: jenkins
diff --git a/src/transport/transport.c b/src/transport/transport.c
index 0af136036..4a1f71d40 100644
--- a/src/transport/transport.c
+++ b/src/transport/transport.c
@@ -52,6 +52,11 @@ static struct transport *transport_list;
*/
static const char * const *allowed_transports;
+/**
+ * Adapter supports a single transport; it has been auto-selected
+ */
+static bool transport_single_is_autoselected;
+
/** * The transport being used for the current OpenOCD session. */
static struct transport *session;
@@ -104,7 +109,8 @@ int allow_transports(struct command_context *ctx, const char * const *vector)
/* autoselect if there's no choice ... */
if (!vector[1]) {
- LOG_INFO("only one transport option; autoselecting '%s'", vector[0]);
+ LOG_DEBUG("only one transport option; autoselecting '%s'", vector[0]);
+ transport_single_is_autoselected = true;
return transport_select(ctx, vector[0]);
}
@@ -182,6 +188,11 @@ COMMAND_HANDLER(handle_transport_init)
return ERROR_FAIL;
}
+ if (transport_single_is_autoselected)
+ LOG_WARNING("DEPRECATED: auto-selecting transport \"%s\". "
+ "Use 'transport select %s' to suppress this message.",
+ session->name, session->name);
+
return session->init(CMD_CTX);
}
@@ -216,8 +227,9 @@ COMMAND_HANDLER(handle_transport_select)
command_print(CMD, "Debug adapter does not support any transports? Check config file order.");
return ERROR_FAIL;
}
- LOG_INFO("auto-selecting first available session transport \"%s\". "
- "To override use 'transport select <transport>'.", allowed_transports[0]);
+ LOG_WARNING("DEPRECATED: auto-selecting transport \"%s\". "
+ "Use 'transport select %s' to suppress this message.",
+ allowed_transports[0], allowed_transports[0]);
int retval = transport_select(CMD_CTX, allowed_transports[0]);
if (retval != ERROR_OK)
return retval;
@@ -229,6 +241,11 @@ COMMAND_HANDLER(handle_transport_select)
/* assign transport */
if (session) {
if (!strcmp(session->name, CMD_ARGV[0])) {
+ if (transport_single_is_autoselected) {
+ /* Nothing to do, but also nothing to complain */
+ transport_single_is_autoselected = false;
+ return ERROR_OK;
+ }
LOG_WARNING("Transport \"%s\" was already selected", session->name);
return ERROR_OK;
}
-----------------------------------------------------------------------
Summary of changes:
src/jtag/adapter.c | 12 +--
src/jtag/core.c | 10 +--
src/jtag/drivers/am335xgpio.c | 5 +-
src/jtag/drivers/amt_jtagaccel.c | 3 +-
src/jtag/drivers/angie.c | 3 +-
src/jtag/drivers/arm-jtag-ew.c | 3 +-
src/jtag/drivers/at91rm9200.c | 3 +-
src/jtag/drivers/bcm2835gpio.c | 5 +-
src/jtag/drivers/buspirate.c | 5 +-
src/jtag/drivers/cmsis_dap.c | 5 +-
src/jtag/drivers/dmem.c | 5 +-
src/jtag/drivers/dummy.c | 3 +-
src/jtag/drivers/ep93xx.c | 3 +-
src/jtag/drivers/esp_usb_jtag.c | 3 +-
src/jtag/drivers/ft232r.c | 3 +-
src/jtag/drivers/ftdi.c | 5 +-
src/jtag/drivers/gw16012.c | 3 +-
src/jtag/drivers/imx_gpio.c | 5 +-
src/jtag/drivers/jlink.c | 5 +-
src/jtag/drivers/jtag_dpi.c | 3 +-
src/jtag/drivers/jtag_vpi.c | 3 +-
src/jtag/drivers/kitprog.c | 5 +-
src/jtag/drivers/linuxgpiod.c | 5 +-
src/jtag/drivers/linuxspidev.c | 6 +-
src/jtag/drivers/opendous.c | 3 +-
src/jtag/drivers/openjtag.c | 3 +-
src/jtag/drivers/osbdm.c | 3 +-
src/jtag/drivers/parport.c | 3 +-
src/jtag/drivers/presto.c | 3 +-
src/jtag/drivers/remote_bitbang.c | 5 +-
src/jtag/drivers/rlink.c | 3 +-
src/jtag/drivers/rshim.c | 5 +-
src/jtag/drivers/stlink_usb.c | 5 +-
src/jtag/drivers/sysfsgpio.c | 5 +-
src/jtag/drivers/ulink.c | 3 +-
src/jtag/drivers/usb_blaster/usb_blaster.c | 3 +-
src/jtag/drivers/usbprog.c | 3 +-
src/jtag/drivers/vdebug.c | 5 +-
src/jtag/drivers/vsllink.c | 5 +-
src/jtag/drivers/xds110.c | 5 +-
src/jtag/drivers/xlnx-pcie-xvc.c | 5 +-
src/jtag/hla/hla_interface.c | 3 +-
src/jtag/hla/hla_interface.h | 2 -
src/jtag/hla/hla_transport.c | 21 +++--
src/jtag/interface.h | 15 +++-
src/jtag/swim.c | 2 +-
src/target/adi_v5_dapdirect.c | 4 +-
src/target/adi_v5_swd.c | 2 +-
src/transport/transport.c | 130 ++++++++++++++++++++++-------
src/transport/transport.h | 33 ++++++--
50 files changed, 247 insertions(+), 143 deletions(-)
hooks/post-receive
--
Main OpenOCD repository
|
