From ed9c257551729cf2dc54fcbc3ad520fdfa9ad0c1 Mon Sep 17 00:00:00 2001 From: oharboe Date: Wed, 22 Oct 2008 09:30:33 +0000 Subject: [PATCH] Laurentiu Cocanu - more help text git-svn-id: svn://svn.berlios.de/openocd/trunk@1087 b42882b7-edfa-0310-969c-e2dbd0fdcd60 --- src/ecosboard.c | 12 ++++++------ src/helper/tclapi.c | 2 +- src/jtag/ft2232.c | 10 +++++----- src/jtag/jtag.c | 2 +- src/jtag/parport.c | 6 +++--- src/server/gdb_server.c | 37 ++++++++++++++++++++++++------------- src/server/tcl_server.c | 2 +- src/server/telnet_server.c | 2 +- src/target/target.c | 10 +++++----- src/target/target_request.c | 2 +- 10 files changed, 48 insertions(+), 37 deletions(-) diff --git a/src/ecosboard.c b/src/ecosboard.c index dfe30059..7af5ea42 100644 --- a/src/ecosboard.c +++ b/src/ecosboard.c @@ -1884,7 +1884,7 @@ int main(int argc, char *argv[]) COMMAND_EXEC, "show zy1000 version numbers"); register_command(cmd_ctx, NULL, "rm", handle_rm_command, COMMAND_ANY, - "rm "); + "remove file"); register_command(cmd_ctx, NULL, "fast_load_image", handle_fast_load_image_command, COMMAND_ANY, "same args as load_image, image stored in memory"); @@ -1893,22 +1893,22 @@ int main(int argc, char *argv[]) "loads active fast load image to current target"); register_command(cmd_ctx, NULL, "cat", handle_cat_command, COMMAND_ANY, - "cat "); + "display file content"); register_command(cmd_ctx, NULL, "trunc", handle_trunc_command, COMMAND_ANY, - "trunc "); + "truncate a file to 0 size"); register_command(cmd_ctx, NULL, "append_file", handle_append_command, - COMMAND_ANY, "append "); + COMMAND_ANY, "append a variable number of strings to a file"); register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY, "power - turn power switch to target on/off. No arguments - print status."); register_command(cmd_ctx, NULL, "meminfo", handle_meminfo_command, - COMMAND_ANY, "meminfo"); + COMMAND_ANY, "display available ram memory"); register_command(cmd_ctx, NULL, "cp", handle_cp_command, - COMMAND_ANY, "cp "); + COMMAND_ANY, "copy a file "); #ifdef CYGPKG_PROFILE_GPROF register_command(cmd_ctx, NULL, "ecosboard_profile", eCosBoard_handle_eCosBoard_profile_command, diff --git a/src/helper/tclapi.c b/src/helper/tclapi.c index f473517d..e07388ff 100644 --- a/src/helper/tclapi.c +++ b/src/helper/tclapi.c @@ -415,7 +415,7 @@ int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args) */ if ((argc < 4) || ((argc % 2)!=0)) { - Jim_WrongNumArgs(interp, 1, args, "wrong arguments"); + Jim_WrongNumArgs(interp, 1, args, " ..."); return JIM_ERR; } diff --git a/src/jtag/ft2232.c b/src/jtag/ft2232.c index 6754d9aa..47376241 100644 --- a/src/jtag/ft2232.c +++ b/src/jtag/ft2232.c @@ -316,15 +316,15 @@ int ft2232_khz(int khz, int *jtag_speed) int ft2232_register_commands(struct command_context_s *cmd_ctx) { register_command(cmd_ctx, NULL, "ft2232_device_desc", ft2232_handle_device_desc_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "the USB device description of the FTDI FT2232 device"); register_command(cmd_ctx, NULL, "ft2232_serial", ft2232_handle_serial_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "the serial number of the FTDI FT2232 device"); register_command(cmd_ctx, NULL, "ft2232_layout", ft2232_handle_layout_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "the layout of the FT2232 GPIO signals used to control output-enables and reset signals"); register_command(cmd_ctx, NULL, "ft2232_vid_pid", ft2232_handle_vid_pid_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "the vendor ID and product ID of the FTDI FT2232 device"); register_command(cmd_ctx, NULL, "ft2232_latency", ft2232_handle_latency_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "set the FT2232 latency timer to a new value"); return ERROR_OK; } diff --git a/src/jtag/jtag.c b/src/jtag/jtag.c index 0af99f93..f2846d3e 100644 --- a/src/jtag/jtag.c +++ b/src/jtag/jtag.c @@ -1555,7 +1555,7 @@ int jtag_register_commands(struct command_context_s *cmd_ctx) register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions"); register_command(cmd_ctx, NULL, "interface", handle_interface_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "try to configure interface"); register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command, COMMAND_ANY, "set jtag speed (if supported)"); register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command, diff --git a/src/jtag/parport.c b/src/jtag/parport.c index 0cfbd81f..13f04904 100644 --- a/src/jtag/parport.c +++ b/src/jtag/parport.c @@ -268,11 +268,11 @@ int parport_speed(int speed) int parport_register_commands(struct command_context_s *cmd_ctx) { register_command(cmd_ctx, NULL, "parport_port", parport_handle_parport_port_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "either the address of the I/O port or the number of the ‘/dev/parport’ device"); register_command(cmd_ctx, NULL, "parport_cable", parport_handle_parport_cable_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "the layout of the parallel port cable used to connect to the target"); register_command(cmd_ctx, NULL, "parport_write_on_exit", parport_handle_write_on_exit_command, - COMMAND_CONFIG, NULL); + COMMAND_CONFIG, "configure the parallel driver to write a known value to the parallel interface"); return ERROR_OK; } diff --git a/src/server/gdb_server.c b/src/server/gdb_server.c index 6dcd493b..8073aecb 100644 --- a/src/server/gdb_server.c +++ b/src/server/gdb_server.c @@ -394,17 +394,17 @@ int gdb_put_packet_inner(connection_t *connection, char *buffer, int len) gdb_putback_char( connection, reply ); return ERROR_OK; } else { - + LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply); gdb_con->closed=1; return ERROR_SERVER_REMOTE_CLOSED; } - } + } else if( reply == '$' ){ LOG_ERROR("GDB missing ack(2) - assumed good"); gdb_putback_char( connection, reply ); return ERROR_OK; - } + } else { LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection", reply); @@ -1985,7 +1985,7 @@ int gdb_input_inner(connection_t *connection) if( LOG_LEVEL_IS( LOG_LVL_DEBUG ) ){ if( packet[0] == 'X' ){ - // binary packets spew junk into the debug log stream + // binary packets spew junk into the debug log stream char buf[ 50 ]; int x; for( x = 0 ; (x < 49) && (packet[x] != ':') ; x++ ){ @@ -2177,7 +2177,10 @@ int gdb_init(void) int handle_gdb_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { if (argc == 0) + { + command_print(cmd_ctx, "gdb_port: %ld", gdb_port); return ERROR_OK; + } /* only if the port wasn't overwritten by cmdline */ if (gdb_port == 0) @@ -2210,9 +2213,11 @@ int handle_gdb_detach_command(struct command_context_s *cmd_ctx, char *cmd, char detach_mode = GDB_DETACH_NOTHING; return ERROR_OK; } + else + LOG_WARNING("invalid gdb_detach configuration directive: %s", args[0]); } - LOG_WARNING("invalid gdb_detach configuration directive: %s", args[0]); + LOG_WARNING("gdb_detach take a single argument"); return ERROR_OK; } @@ -2230,9 +2235,11 @@ int handle_gdb_memory_map_command(struct command_context_s *cmd_ctx, char *cmd, gdb_use_memory_map = 0; return ERROR_OK; } + else + LOG_WARNING("invalid gdb_memory_map configuration directive %s", args[0]); } - LOG_WARNING("invalid gdb_memory_map configuration directive: %s", args[0]); + LOG_WARNING("gdb_memory_map take a single argument"); return ERROR_OK; } @@ -2250,9 +2257,11 @@ int handle_gdb_flash_program_command(struct command_context_s *cmd_ctx, char *cm gdb_flash_program = 0; return ERROR_OK; } + else + LOG_WARNING("invalid gdb_flash_program configuration directive: %s", args[0]); } - LOG_WARNING("invalid gdb_memory_map configuration directive: %s", args[0]); + LOG_WARNING("gdb_flash_program take a single argument"); return ERROR_OK; } @@ -2270,13 +2279,15 @@ int handle_gdb_report_data_abort_command(struct command_context_s *cmd_ctx, char gdb_report_data_abort = 0; return ERROR_OK; } + else + LOG_WARNING("invalid gdb_report_data_abort configuration directive: %s", args[0]); } - LOG_WARNING("invalid gdb_report_data_abort configuration directive: %s", args[0]); + LOG_WARNING("gdb_report_data_abort take a single argument"); return ERROR_OK; } -/* daemon configuration command gdb_port */ +/* gdb_breakpoint_override */ int handle_gdb_breakpoint_override_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { if (argc == 0) @@ -2314,15 +2325,15 @@ int handle_gdb_breakpoint_override_command(struct command_context_s *cmd_ctx, ch int gdb_register_commands(command_context_t *command_context) { register_command(command_context, NULL, "gdb_port", handle_gdb_port_command, - COMMAND_CONFIG, ""); + COMMAND_CONFIG, "daemon configuration command gdb_port"); register_command(command_context, NULL, "gdb_detach", handle_gdb_detach_command, COMMAND_CONFIG, ""); register_command(command_context, NULL, "gdb_memory_map", handle_gdb_memory_map_command, - COMMAND_CONFIG, ""); + COMMAND_CONFIG, "enable or disable memory map"); register_command(command_context, NULL, "gdb_flash_program", handle_gdb_flash_program_command, - COMMAND_CONFIG, ""); + COMMAND_CONFIG, "enable or disable flash program"); register_command(command_context, NULL, "gdb_report_data_abort", handle_gdb_report_data_abort_command, - COMMAND_CONFIG, ""); + COMMAND_CONFIG, "enable or disable report data"); register_command(command_context, NULL, "gdb_breakpoint_override", handle_gdb_breakpoint_override_command, COMMAND_EXEC, "hard/soft/disabled - force breakpoint type for gdb 'break' commands." "The raison d'etre for this option is to support GDB GUI's without " diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c index 8d2a0f71..a6601ffd 100644 --- a/src/server/tcl_server.c +++ b/src/server/tcl_server.c @@ -185,7 +185,7 @@ int tcl_init(void) int tcl_register_commands(command_context_t *cmd_ctx) { - register_command(cmd_ctx, NULL, "tcl_port", handle_tcl_port_command, COMMAND_CONFIG, ""); + register_command(cmd_ctx, NULL, "tcl_port", handle_tcl_port_command, COMMAND_CONFIG, "port on which to listen for incoming TCL syntax"); return ERROR_OK; } diff --git a/src/server/telnet_server.c b/src/server/telnet_server.c index 2d779ec5..85e1957f 100644 --- a/src/server/telnet_server.c +++ b/src/server/telnet_server.c @@ -626,7 +626,7 @@ int telnet_register_commands(command_context_t *command_context) COMMAND_EXEC, "exit telnet session"); register_command(command_context, NULL, "telnet_port", handle_telnet_port_command, - COMMAND_CONFIG, ""); + COMMAND_CONFIG, "port on which to listen for incoming telnet connections"); return ERROR_OK; } diff --git a/src/target/target.c b/src/target/target.c index 5805d0c7..53f88c06 100644 --- a/src/target/target.c +++ b/src/target/target.c @@ -938,10 +938,10 @@ void target_free_all_working_areas(struct target_s *target) int target_register_commands(struct command_context_s *cmd_ctx) { - register_command(cmd_ctx, NULL, "targets", handle_targets_command, COMMAND_EXEC, NULL); - register_command(cmd_ctx, NULL, "working_area", handle_working_area_command, COMMAND_ANY, "working_area
<'backup'|'nobackup'> [virtual address]"); - register_command(cmd_ctx, NULL, "virt2phys", handle_virt2phys_command, COMMAND_ANY, "virt2phys "); - register_command(cmd_ctx, NULL, "profile", handle_profile_command, COMMAND_EXEC, "PRELIMINARY! - profile "); + register_command(cmd_ctx, NULL, "targets", handle_targets_command, COMMAND_EXEC, "change the current command line target (one parameter) or lists targets (with no parameter)"); + register_command(cmd_ctx, NULL, "working_area", handle_working_area_command, COMMAND_ANY, "set a new working space"); + register_command(cmd_ctx, NULL, "virt2phys", handle_virt2phys_command, COMMAND_ANY, "translate a virtual address into a physical address"); + register_command(cmd_ctx, NULL, "profile", handle_profile_command, COMMAND_EXEC, "profiling samples the CPU PC"); register_jim(cmd_ctx, "target", jim_target, "configure target" ); @@ -1311,7 +1311,7 @@ int target_write_u8(struct target_s *target, u32 address, u8 value) int target_register_user_commands(struct command_context_s *cmd_ctx) { int retval = ERROR_OK; - register_command(cmd_ctx, NULL, "reg", handle_reg_command, COMMAND_EXEC, NULL); + register_command(cmd_ctx, NULL, "reg", handle_reg_command, COMMAND_EXEC, "display or set a register"); register_command(cmd_ctx, NULL, "poll", handle_poll_command, COMMAND_EXEC, "poll target state"); register_command(cmd_ctx, NULL, "wait_halt", handle_wait_halt_command, COMMAND_EXEC, "wait for target halt [time (s)]"); register_command(cmd_ctx, NULL, "halt", handle_halt_command, COMMAND_EXEC, "halt target"); diff --git a/src/target/target_request.c b/src/target/target_request.c index df97a65f..b266fea5 100644 --- a/src/target/target_request.c +++ b/src/target/target_request.c @@ -304,7 +304,7 @@ int target_request_register_commands(struct command_context_s *cmd_ctx) register_command(cmd_ctx, NULL, "target_request", NULL, COMMAND_ANY, "target_request commands"); register_command(cmd_ctx, target_request_cmd, "debugmsgs", handle_target_request_debugmsgs_command, - COMMAND_EXEC, "enable/disable reception of debug messgages from target"); + COMMAND_EXEC, "enable/disable reception of debug messages from target"); return ERROR_OK; } -- 2.39.5