jtag: presto, parport help/usage updates
authorDavid Brownell <dbrownell@users.sourceforge.net>
Sun, 10 Jan 2010 06:09:08 +0000 (22:09 -0800)
committerDavid Brownell <dbrownell@users.sourceforge.net>
Sun, 10 Jan 2010 06:09:08 +0000 (22:09 -0800)
Presto: add doxygen file comment.

Parport: note a couple gaps in layout config.

Both: use the uniform EBNF for usage, bugfix helptexts, use function
name as its address not "&name".

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
src/jtag/drivers/parport.c
src/jtag/drivers/presto.c

index b280d04..a38ccfd 100644 (file)
@@ -437,10 +437,13 @@ COMMAND_HANDLER(parport_handle_parport_cable_command)
        /* only if the cable name wasn't overwritten by cmdline */
        if (parport_cable == 0)
        {
+               /* REVISIT first verify that it's listed in cables[] ... */
                parport_cable = malloc(strlen(CMD_ARGV[0]) + sizeof(char));
                strcpy(parport_cable, CMD_ARGV[0]);
        }
 
+       /* REVISIT it's probably worth returning the current value ... */
+
        return ERROR_OK;
 }
 
@@ -484,34 +487,37 @@ COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
 static const struct command_registration parport_command_handlers[] = {
        {
                .name = "parport_port",
-               .handler = &parport_handle_parport_port_command,
+               .handler = parport_handle_parport_port_command,
                .mode = COMMAND_CONFIG,
-               .help = "either the address of the I/O port "
-                       "or the number of the '/dev/parport' device",
-               .usage = "[<port|devname>]",
+               .help = "Display the address of the I/O port (e.g. 0x378) "
+                       "or the number of the '/dev/parport' device used.  "
+                       "If a parameter is provided, first change that port.",
+               .usage = "[port_number]",
        },
        {
                .name = "parport_cable",
-               .handler = &parport_handle_parport_cable_command,
+               .handler = parport_handle_parport_cable_command,
                .mode = COMMAND_CONFIG,
-               .help = "the layout of the parallel port cable "
-                       "used to connect to the target",
-               .usage = "[<layout>]",
+               .help = "Set the layout of the parallel port cable "
+                       "used to connect to the target.",
+               /* REVISIT there's no way to list layouts we know ... */
+               .usage = "[layout]",
        },
        {
                .name = "parport_write_on_exit",
-               .handler = &parport_handle_write_on_exit_command,
+               .handler = parport_handle_write_on_exit_command,
                .mode = COMMAND_CONFIG,
-               .help = "configure the parallel driver to write "
-                       "a known value to the parallel interface",
-               .usage = "[<on|off>]",
+               .help = "Configure the parallel driver to write "
+                       "a known value to the parallel interface on exit.",
+               .usage = "('on'|'off')",
        },
        {
                .name = "parport_toggling_time",
-               .handler = &parport_handle_parport_toggling_time_command,
+               .handler = parport_handle_parport_toggling_time_command,
                .mode = COMMAND_CONFIG,
-               .help = "time <ns> it takes for the hardware to toggle TCK",
-               .usage = "[<ns>]",
+               .help = "Displays or assigns how many nanoseconds it "
+                       "takes for the hardware to toggle TCK.",
+               .usage = "[nanoseconds]",
        },
        COMMAND_REGISTRATION_DONE
 };
index 0baf561..ababf09 100644 (file)
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
+/**
+ * @file Holds driver for PRESTO programmer from ASIX.
+ * http://tools.asix.net/prg_presto.htm
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -742,10 +747,10 @@ COMMAND_HANDLER(presto_handle_serial_command)
 static const struct command_registration presto_command_handlers[] = {
        {
                .name = "presto_serial",
-               .handler = &presto_handle_serial_command,
+               .handler = presto_handle_serial_command,
                .mode = COMMAND_CONFIG,
-               .help = "configure serial port",
-               .usage = "<devname>",
+               .help = "Configure USB serial number of Presto device.",
+               .usage = "serial_string",
        },
        COMMAND_REGISTRATION_DONE
 };