From 679dcd0b52f6bafe848eb48e714764d37a101bb5 Mon Sep 17 00:00:00 2001 From: Antonio Borneo Date: Thu, 7 Oct 2021 14:30:43 +0200 Subject: [PATCH] jtag: move prototype of adapter init/quit and speed to adapter.h After moved the code, align the include files. Change-Id: I514a3020648816810d69f76c2ec4f6e52a1c57ab Signed-off-by: Antonio Borneo Reviewed-on: https://review.openocd.org/c/openocd/+/6643 Tested-by: jenkins Reviewed-by: Tarek BOCHKATI --- src/jtag/adapter.h | 32 ++++++++++++++++++++++++++++++++ src/jtag/drivers/amt_jtagaccel.c | 1 + src/jtag/drivers/cmsis_dap.c | 1 + src/jtag/drivers/parport.c | 1 + src/jtag/drivers/vsllink.c | 1 + src/jtag/jtag.h | 31 ------------------------------- src/jtag/tcl.c | 1 + src/openocd.c | 1 + src/target/mips32_pracc.c | 1 + src/target/mips64_pracc.c | 1 + 10 files changed, 40 insertions(+), 31 deletions(-) diff --git a/src/jtag/adapter.h b/src/jtag/adapter.h index fe9a6318c4..b2405e9842 100644 --- a/src/jtag/adapter.h +++ b/src/jtag/adapter.h @@ -10,6 +10,14 @@ #include #include +struct command_context; + +/** Initialize debug adapter upon startup. */ +int adapter_init(struct command_context *cmd_ctx); + +/** Shutdown the debug adapter upon program exit. */ +int adapter_quit(void); + /** @returns true if adapter has been initialized */ bool is_adapter_initialized(void); @@ -19,4 +27,28 @@ const char *adapter_usb_get_location(void); /** @returns true if USB location string is "-[.[...]]" */ bool adapter_usb_location_equal(uint8_t dev_bus, uint8_t *port_path, size_t path_len); +/** @returns The current JTAG speed setting. */ +int jtag_get_speed(int *speed); + +/** + * Given a @a speed setting, use the interface @c speed_div callback to + * adjust the setting. + * @param speed The speed setting to convert back to readable KHz. + * @returns ERROR_OK if the interface has not been initialized or on success; + * otherwise, the error code produced by the @c speed_div callback. + */ +int jtag_get_speed_readable(int *speed); + +/** Attempt to configure the interface for the specified KHz. */ +int jtag_config_khz(unsigned khz); + +/** + * Attempt to enable RTCK/RCLK. If that fails, fallback to the + * specified frequency. + */ +int jtag_config_rclk(unsigned fallback_speed_khz); + +/** Retrieves the clock speed of the JTAG interface in KHz. */ +unsigned jtag_get_speed_khz(void); + #endif /* OPENOCD_JTAG_ADAPTER_H */ diff --git a/src/jtag/drivers/amt_jtagaccel.c b/src/jtag/drivers/amt_jtagaccel.c index e9ff8dfa1d..b73c661614 100644 --- a/src/jtag/drivers/amt_jtagaccel.c +++ b/src/jtag/drivers/amt_jtagaccel.c @@ -20,6 +20,7 @@ #include "config.h" #endif +#include #include #if PARPORT_USE_PPDEV == 1 diff --git a/src/jtag/drivers/cmsis_dap.c b/src/jtag/drivers/cmsis_dap.c index 9bd4cb73a4..289ffcd92a 100644 --- a/src/jtag/drivers/cmsis_dap.c +++ b/src/jtag/drivers/cmsis_dap.c @@ -40,6 +40,7 @@ #include #include "helper/replacements.h" +#include #include #include #include diff --git a/src/jtag/drivers/parport.c b/src/jtag/drivers/parport.c index d50d306d32..714cb1daad 100644 --- a/src/jtag/drivers/parport.c +++ b/src/jtag/drivers/parport.c @@ -23,6 +23,7 @@ #include "config.h" #endif +#include #include #include "bitbang.h" diff --git a/src/jtag/drivers/vsllink.c b/src/jtag/drivers/vsllink.c index 7325f6abc4..5d771443cd 100644 --- a/src/jtag/drivers/vsllink.c +++ b/src/jtag/drivers/vsllink.c @@ -24,6 +24,7 @@ #include "config.h" #endif +#include #include #include #include diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h index feb4614fa6..d7d7d977c2 100644 --- a/src/jtag/jtag.h +++ b/src/jtag/jtag.h @@ -217,31 +217,6 @@ int jtag_unregister_event_callback(jtag_event_handler_t f, void *x); int jtag_call_event_callbacks(enum jtag_event event); - -/** @returns The current JTAG speed setting. */ -int jtag_get_speed(int *speed); - -/** - * Given a @a speed setting, use the interface @c speed_div callback to - * adjust the setting. - * @param speed The speed setting to convert back to readable KHz. - * @returns ERROR_OK if the interface has not been initialized or on success; - * otherwise, the error code produced by the @c speed_div callback. - */ -int jtag_get_speed_readable(int *speed); - -/** Attempt to configure the interface for the specified KHz. */ -int jtag_config_khz(unsigned khz); - -/** - * Attempt to enable RTCK/RCLK. If that fails, fallback to the - * specified frequency. - */ -int jtag_config_rclk(unsigned fallback_speed_khz); - -/** Retrieves the clock speed of the JTAG interface in KHz. */ -unsigned jtag_get_speed_khz(void); - enum reset_types { RESET_NONE = 0x0, RESET_HAS_TRST = 0x1, @@ -285,12 +260,6 @@ void jtag_set_verify_capture_ir(bool enable); /** @returns True if IR scan verification will be performed. */ bool jtag_will_verify_capture_ir(void); -/** Initialize debug adapter upon startup. */ -int adapter_init(struct command_context *cmd_ctx); - -/** Shutdown the debug adapter upon program exit. */ -int adapter_quit(void); - /** Set ms to sleep after jtag_execute_queue() flushes queue. Debug purposes. */ void jtag_set_flush_queue_sleep(int ms); diff --git a/src/jtag/tcl.c b/src/jtag/tcl.c index 6d3fee43cd..8bf4ea9c10 100644 --- a/src/jtag/tcl.c +++ b/src/jtag/tcl.c @@ -30,6 +30,7 @@ #include "config.h" #endif +#include "adapter.h" #include "jtag.h" #include "swd.h" #include "minidriver.h" diff --git a/src/openocd.c b/src/openocd.c index 12bd52c585..e8c526bfd1 100644 --- a/src/openocd.c +++ b/src/openocd.c @@ -27,6 +27,7 @@ #endif #include "openocd.h" +#include #include #include #include diff --git a/src/target/mips32_pracc.c b/src/target/mips32_pracc.c index 923cdf8772..ebe02e66d2 100644 --- a/src/target/mips32_pracc.c +++ b/src/target/mips32_pracc.c @@ -70,6 +70,7 @@ #include #include +#include #include "mips32.h" #include "mips32_pracc.h" diff --git a/src/target/mips64_pracc.c b/src/target/mips64_pracc.c index bb2af228d3..d68521d632 100644 --- a/src/target/mips64_pracc.c +++ b/src/target/mips64_pracc.c @@ -21,6 +21,7 @@ #include "mips64_pracc.h" #include +#include #define STACK_DEPTH 32 -- 2.30.2