rename jtag_interface_{init,quit}()

These routines apply to non-JTAG debug adapters too.  To
reduce confusion, give them better (non-misleading) names.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
This commit is contained in:
David Brownell 2010-03-14 13:13:39 -07:00
parent c23d4596d2
commit c25fda2c95
4 changed files with 21 additions and 18 deletions

View File

@ -1346,7 +1346,11 @@ void jtag_tap_free(struct jtag_tap *tap)
free(tap); free(tap);
} }
int jtag_interface_init(struct command_context *cmd_ctx) /**
* Do low-level setup like initializing registers, output signals,
* and clocking.
*/
int adapter_init(struct command_context *cmd_ctx)
{ {
if (jtag) if (jtag)
return ERROR_OK; return ERROR_OK;
@ -1354,7 +1358,8 @@ int jtag_interface_init(struct command_context *cmd_ctx)
if (!jtag_interface) if (!jtag_interface)
{ {
/* nothing was previously specified by "interface" command */ /* nothing was previously specified by "interface" command */
LOG_ERROR("JTAG interface has to be specified, see \"interface\" command"); LOG_ERROR("Debug Adapter has to be specified, "
"see \"interface\" command");
return ERROR_JTAG_INVALID_INTERFACE; return ERROR_JTAG_INVALID_INTERFACE;
} }
@ -1369,9 +1374,10 @@ int jtag_interface_init(struct command_context *cmd_ctx)
int actual_khz = requested_khz; int actual_khz = requested_khz;
int retval = jtag_get_speed_readable(&actual_khz); int retval = jtag_get_speed_readable(&actual_khz);
if (ERROR_OK != retval) if (ERROR_OK != retval)
LOG_INFO("interface specific clock speed value %d", jtag_get_speed()); LOG_INFO("adapter-specific clock speed value %d", jtag_get_speed());
else if (actual_khz) else if (actual_khz)
{ {
/* Adaptive clocking -- JTAG-specific */
if ((CLOCK_MODE_RCLK == clock_mode) if ((CLOCK_MODE_RCLK == clock_mode)
|| ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz)) || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz))
{ {
@ -1459,7 +1465,7 @@ int jtag_init_inner(struct command_context *cmd_ctx)
return ERROR_OK; return ERROR_OK;
} }
int jtag_interface_quit(void) int adapter_quit(void)
{ {
if (!jtag || !jtag->quit) if (!jtag || !jtag->quit)
return ERROR_OK; return ERROR_OK;
@ -1477,7 +1483,7 @@ int jtag_init_reset(struct command_context *cmd_ctx)
{ {
int retval; int retval;
if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK) if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
return retval; return retval;
LOG_DEBUG("Initializing with hard TRST+SRST reset"); LOG_DEBUG("Initializing with hard TRST+SRST reset");
@ -1531,7 +1537,7 @@ int jtag_init(struct command_context *cmd_ctx)
{ {
int retval; int retval;
if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK) if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
return retval; return retval;
/* guard against oddball hardware: force resets to be inactive */ /* guard against oddball hardware: force resets to be inactive */

View File

@ -305,14 +305,11 @@ void jtag_set_verify_capture_ir(bool enable);
/// @returns True if IR scan verification will be performed. /// @returns True if IR scan verification will be performed.
bool jtag_will_verify_capture_ir(void); bool jtag_will_verify_capture_ir(void);
/** /** Initialize debug adapter upon startup. */
* Initialize interface upon startup. Return a successful no-op upon int adapter_init(struct command_context* cmd_ctx);
* subsequent invocations.
*/
int jtag_interface_init(struct command_context* cmd_ctx);
/// Shutdown the JTAG interface upon program exit. /// Shutdown the debug adapter upon program exit.
int jtag_interface_quit(void); int adapter_quit(void);
/** /**
* Initialize JTAG chain using only a RESET reset. If init fails, * Initialize JTAG chain using only a RESET reset. If init fails,

View File

@ -1430,7 +1430,7 @@ COMMAND_HANDLER(handle_jtag_reset_command)
else else
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
if (jtag_interface_init(CMD_CTX) != ERROR_OK) if (adapter_init(CMD_CTX) != ERROR_OK)
return ERROR_JTAG_INIT_FAILED; return ERROR_JTAG_INIT_FAILED;
jtag_add_reset(trst, srst); jtag_add_reset(trst, srst);

View File

@ -115,12 +115,12 @@ COMMAND_HANDLER(handle_init_command)
if (ERROR_OK != retval) if (ERROR_OK != retval)
return ERROR_FAIL; return ERROR_FAIL;
if ((retval = jtag_interface_init(CMD_CTX)) != ERROR_OK) if ((retval = adapter_init(CMD_CTX)) != ERROR_OK)
{ {
/* we must be able to set up the jtag interface */ /* we must be able to set up the debug adapter */
return retval; return retval;
} }
LOG_DEBUG("jtag interface init complete"); LOG_DEBUG("Debug Adapter init complete");
/* Try to initialize & examine the JTAG chain at this point, /* Try to initialize & examine the JTAG chain at this point,
* but continue startup regardless. Note that platforms * but continue startup regardless. Note that platforms
@ -297,7 +297,7 @@ int openocd_main(int argc, char *argv[])
/* free commandline interface */ /* free commandline interface */
command_done(cmd_ctx); command_done(cmd_ctx);
jtag_interface_quit(); adapter_quit();
return ret; return ret;
} }