interesting
/
riscv-openocd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

src/target/riscv: Update nuclei command handling and logging improvements 

- Ensure commands expect correct parameters.
- Use consistent error messages.

Change-Id: Ib1e637d4ea319567d792da45628b624a298ec72e
Signed-off-by: Huaqi Fang <578567190@qq.com>
This commit is contained in:
Huaqi Fang 2024-12-13 13:45:14 +08:00
parent c917af5e16
commit 29cb3fdfd5
1 changed files with 50 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
src/target/riscv/nuclei_riscv.c
View File

@ -387,13 +387,20 @@ static target_addr_t atb2axi_config_addr = 0xa5a5a5a5;
static target_addr_t buffer_addr = 0xa5a5a5a5; static target_addr_t buffer_addr = 0xa5a5a5a5;
static uint32_t buffer_size; static uint32_t buffer_size;
#define CHECK_ETRACE_CONFIGURED() { \
if (atb2axi_config_addr == 0xa5a5a5a5) { \
LOG_ERROR("ETrace is not configured, please configure it first!"); \
LOG_INFO("eg. nuclei etrace config <atb2axi-addr> <buffer-addr> <buffer-size> <wrap>"); \
return ERROR_OK; \
} \
}
static int etrace_read_reg(struct target *target, uint32_t offset, uint32_t *value) static int etrace_read_reg(struct target *target, uint32_t offset, uint32_t *value)
{ {
if (atb2axi_config_addr == 0xa5a5a5a5) CHECK_ETRACE_CONFIGURED();
return ERROR_OK;
int result = target_read_u32(target, atb2axi_config_addr + offset, value); int result = target_read_u32(target, atb2axi_config_addr + offset, value);
if (result != ERROR_OK) { if (result != ERROR_OK) {
LOG_ERROR("%s error at %#x", __func__, atb2axi_config_addr + offset); LOG_ERROR("Failed to read etrace atb2axi register at %#x", atb2axi_config_addr + offset);
return result; return result;
} }
return ERROR_OK; return ERROR_OK;
@ -401,11 +408,10 @@ static int etrace_read_reg(struct target *target, uint32_t offset, uint32_t *val
static int etrace_write_reg(struct target *target, uint32_t offset, uint32_t value) static int etrace_write_reg(struct target *target, uint32_t offset, uint32_t value)
{ {
if (atb2axi_config_addr == 0xa5a5a5a5) CHECK_ETRACE_CONFIGURED();
return ERROR_OK;
int result = target_write_u32(target, atb2axi_config_addr + offset, value); int result = target_write_u32(target, atb2axi_config_addr + offset, value);
if (result != ERROR_OK) { if (result != ERROR_OK) {
LOG_ERROR("%s error writing %#x to %#x", __func__, value, atb2axi_config_addr + offset); LOG_ERROR("Failed to write etrace atb2axi register %#x with %#x", value, atb2axi_config_addr + offset);
return result; return result;
} }
return ERROR_OK; return ERROR_OK;
@ -416,6 +422,7 @@ void etrace_stop(struct target *target)
uint32_t tmp; uint32_t tmp;
uint32_t wait_idle = 0x100; uint32_t wait_idle = 0x100;
CHECK_ETRACE_CONFIGURED();
etrace_write_reg(target, ETRACE_ENA, 0); etrace_write_reg(target, ETRACE_ENA, 0);
do { do {
etrace_read_reg(target, ETRACE_IDLE, &tmp); etrace_read_reg(target, ETRACE_IDLE, &tmp);
@ -434,12 +441,12 @@ COMMAND_HANDLER(handle_etrace_config_command)
struct target *target = get_current_target(CMD_CTX); struct target *target = get_current_target(CMD_CTX);
uint32_t tmp; uint32_t tmp = 0;
if (atb2axi_config_addr != 0xa5a5a5a5)
etrace_read_reg(target, ETRACE_ENA, &tmp); etrace_read_reg(target, ETRACE_ENA, &tmp);
if (tmp) { if (tmp) {
LOG_ERROR("etrace already start, please stop it first and then config."); LOG_ERROR("ETrace is still running, please run nuclei etrace stop to stop it first!");
return 0; return ERROR_OK;
} }
COMMAND_PARSE_NUMBER(target_addr, CMD_ARGV[0], atb2axi_config_addr); COMMAND_PARSE_NUMBER(target_addr, CMD_ARGV[0], atb2axi_config_addr);
@ -447,7 +454,11 @@ COMMAND_HANDLER(handle_etrace_config_command)
COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], buffer_size); COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], buffer_size);
COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], wrap); COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], wrap);
etrace_write_reg(target, ETRACE_ENDOFFSET, 0); if (etrace_write_reg(target, ETRACE_ENDOFFSET, 0) != ERROR_OK) {
/* Only check first register write, if ok, assume configured correct */
LOG_ERROR("Unable to write etrace atb2axi register, please check!");
return ERROR_FAIL;
}
etrace_write_reg(target, ETRACE_FLG, 0); etrace_write_reg(target, ETRACE_FLG, 0);
etrace_write_reg(target, ETRACE_BASE_HI, (uint32_t)(buffer_addr >> 32)); etrace_write_reg(target, ETRACE_BASE_HI, (uint32_t)(buffer_addr >> 32));
etrace_write_reg(target, ETRACE_BASE_LO, (uint32_t)buffer_addr); etrace_write_reg(target, ETRACE_BASE_LO, (uint32_t)buffer_addr);
@ -549,6 +560,7 @@ COMMAND_HANDLER(handle_etrace_start_command)
if (CMD_ARGC > 0) if (CMD_ARGC > 0)
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
CHECK_ETRACE_CONFIGURED();
struct target *target = get_current_target(CMD_CTX); struct target *target = get_current_target(CMD_CTX);
etrace_write_reg(target, ETRACE_ENA, 1); etrace_write_reg(target, ETRACE_ENA, 1);
@ -561,6 +573,7 @@ COMMAND_HANDLER(handle_etrace_stop_command)
if (CMD_ARGC > 0) if (CMD_ARGC > 0)
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
CHECK_ETRACE_CONFIGURED();
struct target *target = get_current_target(CMD_CTX); struct target *target = get_current_target(CMD_CTX);
etrace_stop(target); etrace_stop(target);
@ -574,22 +587,23 @@ COMMAND_HANDLER(handle_etrace_dump_command)
uint32_t full_flag; uint32_t full_flag;
target_addr_t address; target_addr_t address;
uint32_t size; uint32_t size;
uint8_t *temp; uint8_t *temp = NULL;
struct fileio *fileio; struct fileio *fileio = NULL;
int retval, retvaltemp; int retval = ERROR_OK;
struct duration bench; struct duration bench;
if (CMD_ARGC != 1) if (CMD_ARGC != 1)
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
CHECK_ETRACE_CONFIGURED();
struct target *target = get_current_target(CMD_CTX); struct target *target = get_current_target(CMD_CTX);
uint32_t tmp; uint32_t tmp = 0;
etrace_read_reg(target, ETRACE_ENA, &tmp); etrace_read_reg(target, ETRACE_ENA, &tmp);
if (tmp) { if (tmp) {
LOG_ERROR("etrace already start, please stop it first and then dump."); LOG_ERROR("ETrace is still running, please use nuclei etrace stop to stop it first!");
return 0; return ERROR_OK;
} }
etrace_read_reg(target, ETRACE_ENDOFFSET, &end_offset); etrace_read_reg(target, ETRACE_ENDOFFSET, &end_offset);
@ -608,7 +622,7 @@ COMMAND_HANDLER(handle_etrace_dump_command)
return ERROR_FAIL; return ERROR_FAIL;
if (fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK) if (fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
return ERROR_FAIL; goto fail;
duration_start(&bench); duration_start(&bench);
@ -633,21 +647,22 @@ COMMAND_HANDLER(handle_etrace_dump_command)
address += this_run_size; address += this_run_size;
} }
free(temp);
if (retval == ERROR_OK && (duration_measure(&bench) == ERROR_OK)) { if (retval == ERROR_OK && (duration_measure(&bench) == ERROR_OK)) {
size_t filesize; size_t filesize;
retval = fileio_size(fileio, &filesize); fileio_size(fileio, &filesize);
if (retval != ERROR_OK)
return retval;
command_print(CMD, command_print(CMD,
"dumped %zu bytes in %fs (%0.3f KiB/s)", filesize, "dumped %zu bytes in %fs (%0.3f KiB/s)", filesize,
duration_elapsed(&bench), duration_kbps(&bench, filesize)); duration_elapsed(&bench), duration_kbps(&bench, filesize));
} }
retvaltemp = fileio_close(fileio); retval = ERROR_OK;
if (retvaltemp != ERROR_OK) fail:
return retvaltemp; retval = ERROR_FAIL;
ok:
if (!fileio)
fileio_close(fileio);
if (!temp)
free(temp);
return retval; return retval;
} }
@ -657,6 +672,7 @@ COMMAND_HANDLER(handle_etrace_clear_command)
if (CMD_ARGC > 0) if (CMD_ARGC > 0)
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
CHECK_ETRACE_CONFIGURED();
struct target *target = get_current_target(CMD_CTX); struct target *target = get_current_target(CMD_CTX);
etrace_stop(target); etrace_stop(target);
@ -672,6 +688,7 @@ COMMAND_HANDLER(handle_etrace_info_command)
uint32_t end_offset; uint32_t end_offset;
uint32_t full_flag; uint32_t full_flag;
CHECK_ETRACE_CONFIGURED();
if (CMD_ARGC > 0) if (CMD_ARGC > 0)
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
@ -680,7 +697,7 @@ COMMAND_HANDLER(handle_etrace_info_command)
etrace_read_reg(target, ETRACE_ENDOFFSET, &end_offset); etrace_read_reg(target, ETRACE_ENDOFFSET, &end_offset);
etrace_read_reg(target, ETRACE_FLG, &full_flag); etrace_read_reg(target, ETRACE_FLG, &full_flag);
command_print(CMD, "ATB2AXI Addr: %#x", atb2axi_config_addr); command_print(CMD, "ATB2AXI Addr: %#lx", atb2axi_config_addr);
command_print(CMD, "Buffer Addr: %#lx", buffer_addr); command_print(CMD, "Buffer Addr: %#lx", buffer_addr);
command_print(CMD, "Buffer Size: %#x", buffer_size); command_print(CMD, "Buffer Size: %#x", buffer_size);
command_print_sameline(CMD, "Buffer Status: "); command_print_sameline(CMD, "Buffer Status: ");
@ -699,7 +716,7 @@ static const struct command_registration etrace_command_handlers[] = {
.handler = handle_etrace_config_command, .handler = handle_etrace_config_command,
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.help = "Configuration etrace.", .help = "Configuration etrace.",
.usage = "atb2axi-config-addr buffer-addr buffer-size wrap", .usage = "atb2axi--addr buffer-addr buffer-size wrap",
}, },
{ {
.name = "enable", .name = "enable",
@ -792,7 +809,7 @@ uint64_t nuclei_get_dmcustom(struct target *target, uint32_t type, uint32_t hart
COMMAND_HANDLER(nuclei_set_expose_cpu_core) COMMAND_HANDLER(nuclei_set_expose_cpu_core)
{ {
if (CMD_ARGC == 0) { if (CMD_ARGC == 0) {
LOG_ERROR("Command expects parameters"); LOG_ERROR("This command expects at least 1 parameters");
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
} }
@ -812,7 +829,7 @@ COMMAND_HANDLER(nuclei_set_expose_cpu_core)
COMMAND_HANDLER(nuclei_set_examine_cpu_core) COMMAND_HANDLER(nuclei_set_examine_cpu_core)
{ {
if (CMD_ARGC == 0) { if (CMD_ARGC == 0) {
LOG_ERROR("Command expects parameters"); LOG_ERROR("This command expects at least 1 parameters");
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
} }
@ -848,7 +865,7 @@ COMMAND_HANDLER(nuclei_set_examine_cpu_core)
COMMAND_HANDLER(handle_halt_group_command) COMMAND_HANDLER(handle_halt_group_command)
{ {
if (CMD_ARGC < 2) { if (CMD_ARGC < 2) {
LOG_ERROR("Command expects parameters"); LOG_ERROR("This command expects at least 2 parameters");
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
} }
@ -875,7 +892,7 @@ COMMAND_HANDLER(handle_halt_group_command)
COMMAND_HANDLER(handle_resume_group_command) COMMAND_HANDLER(handle_resume_group_command)
{ {
if (CMD_ARGC < 2) { if (CMD_ARGC < 2) {
LOG_ERROR("Command expects parameters"); LOG_ERROR("This command expects at least 2 parameters");
return ERROR_COMMAND_SYNTAX_ERROR; return ERROR_COMMAND_SYNTAX_ERROR;
} }