parport: fix parport_toggling_time regression
[openocd.git] / src / jtag / drivers / parport.c
index e5f56113f2473e01ef79ae95eff9ec945740f419..7dd842e0fcfe1fbdce578eeb64292281116593db 100644 (file)
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#include "interface.h"
+#include <jtag/interface.h>
 #include "bitbang.h"
 
 /* -ino: 060521-1036 */
 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 #include <machine/sysarch.h>
 #include <machine/cpufunc.h>
-#define ioperm(startport,length,enable)\
-  i386_set_ioperm((startport), (length), (enable))
+#define ioperm(startport, length, enable)\
+       i386_set_ioperm((startport), (length), (enable))
 #endif /* __FreeBSD__ */
 
 #if PARPORT_USE_PPDEV == 1
 #include <windows.h>
 #endif
 
-
 /* parallel port cable description
  */
 struct cable {
-       charname;
+       char *name;
        uint8_t TDO_MASK;       /* status port bit containing current TDO value */
        uint8_t TRST_MASK;      /* data port bit for TRST */
        uint8_t TMS_MASK;       /* data port bit for TMS */
@@ -74,14 +74,12 @@ struct cable {
        uint8_t LED_MASK;       /* data port bit for LED */
 };
 
-static struct cable cables[] =
-{
-       /* name                                 tdo   trst  tms   tck   tdi   srst  o_inv i_inv init  exit  led */
+static struct cable cables[] = {
+       /* name                         tdo   trst  tms   tck   tdi   srst  o_inv i_inv init  exit  led */
        { "wiggler",                    0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x80, 0x00 },
        { "wiggler2",                   0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x00, 0x20 },
-       { "wiggler_ntrst_inverted",
-                                                       0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x11, 0x80, 0x80, 0x80, 0x00 },
-       { "old_amt_wiggler",    0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x11, 0x80, 0x80, 0x80, 0x00 },
+       { "wiggler_ntrst_inverted",     0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x11, 0x80, 0x80, 0x80, 0x00 },
+       { "old_amt_wiggler",            0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x11, 0x80, 0x80, 0x80, 0x00 },
        { "arm-jtag",                   0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x01, 0x80, 0x80, 0x80, 0x00 },
        { "chameleon",                  0x80, 0x00, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
        { "dlc5",                               0x10, 0x00, 0x04, 0x02, 0x01, 0x00, 0x00, 0x00, 0x10, 0x10, 0x00 },
@@ -101,16 +99,16 @@ static struct cable cables[] =
 };
 
 /* configuration */
-static char* parport_cable = NULL;
+static char *parport_cable;
 static uint16_t parport_port;
-static bool parport_exit = 0;
+static bool parport_exit;
 static uint32_t parport_toggling_time_ns = 1000;
 static int wait_states;
 
 /* interface variables
  */
-static struct cablecable;
-static uint8_t dataport_value = 0x0;
+static struct cable *cable;
+static uint8_t dataport_value;
 
 #if PARPORT_USE_PPDEV == 1
 static int device_handle;
@@ -124,7 +122,7 @@ static int parport_read(void)
        int data = 0;
 
 #if PARPORT_USE_PPDEV == 1
-       ioctl(device_handle, PPRSTATUS, & data);
+       ioctl(device_handle, PPRSTATUS, &data);
 #else
        data = inb(statusport);
 #endif
@@ -135,7 +133,7 @@ static int parport_read(void)
                return 0;
 }
 
-static __inline__ void parport_write_data(void)
+static inline void parport_write_data(void)
 {
        uint8_t output;
        output = dataport_value ^ cable->OUTPUT_INVERT;
@@ -209,7 +207,7 @@ static int parport_speed(int speed)
        return ERROR_OK;
 }
 
-static int parport_khz(int khz, intjtag_speed)
+static int parport_khz(int khz, int *jtag_speed)
 {
        if (khz == 0) {
                LOG_DEBUG("RCLK not supported");
@@ -220,7 +218,7 @@ static int parport_khz(int khz, int* jtag_speed)
        return ERROR_OK;
 }
 
-static int parport_speed_div(int speed, intkhz)
+static int parport_speed_div(int speed, int *khz)
 {
        uint32_t denominator = (speed + 1) * parport_toggling_time_ns;
 
@@ -266,29 +264,24 @@ static int parport_init(void)
        struct cable *cur_cable;
 #if PARPORT_USE_PPDEV == 1
        char buffer[256];
-       int i = 0;
 #endif
 
        cur_cable = cables;
 
-       if ((parport_cable == NULL) || (parport_cable[0] == 0))
-       {
-               parport_cable = "wiggler";
+       if (parport_cable == NULL) {
+               parport_cable = strdup("wiggler");
                LOG_WARNING("No parport cable specified, using default 'wiggler'");
        }
 
-       while (cur_cable->name)
-       {
-               if (strcmp(cur_cable->name, parport_cable) == 0)
-               {
+       while (cur_cable->name) {
+               if (strcmp(cur_cable->name, parport_cable) == 0) {
                        cable = cur_cable;
                        break;
                }
                cur_cable++;
        }
 
-       if (!cable)
-       {
+       if (!cable) {
                LOG_ERROR("No matching cable found for %s", parport_cable);
                return ERROR_JTAG_INIT_FAILED;
        }
@@ -296,8 +289,7 @@ static int parport_init(void)
        dataport_value = cable->PORT_INIT;
 
 #if PARPORT_USE_PPDEV == 1
-       if (device_handle > 0)
-       {
+       if (device_handle > 0) {
                LOG_ERROR("device is already opened");
                return ERROR_JTAG_INIT_FAILED;
        }
@@ -314,8 +306,7 @@ static int parport_init(void)
        device_handle = open(buffer, O_WRONLY);
 #endif /* __FreeBSD__, __FreeBSD_kernel__ */
 
-       if (device_handle < 0)
-       {
+       if (device_handle < 0) {
                int err = errno;
                LOG_ERROR("cannot open device. check it exists and that user read and write rights are set. errno=%d", err);
                return ERROR_JTAG_INIT_FAILED;
@@ -324,33 +315,30 @@ static int parport_init(void)
        LOG_DEBUG("...open");
 
 #if !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
-       i = ioctl(device_handle, PPCLAIM);
-       if (i < 0)
-       {
+       int i = ioctl(device_handle, PPCLAIM);
+
+       if (i < 0) {
                LOG_ERROR("cannot claim device");
                return ERROR_JTAG_INIT_FAILED;
        }
 
        i = PARPORT_MODE_COMPAT;
-       i= ioctl(device_handle, PPSETMODE, & i);
-       if (i < 0)
-       {
+       i = ioctl(device_handle, PPSETMODE, &i);
+       if (i < 0) {
                LOG_ERROR(" cannot set compatible mode to device");
                return ERROR_JTAG_INIT_FAILED;
        }
 
        i = IEEE1284_MODE_COMPAT;
-       i = ioctl(device_handle, PPNEGOT, & i);
-       if (i < 0)
-       {
+       i = ioctl(device_handle, PPNEGOT, &i);
+       if (i < 0) {
                LOG_ERROR("cannot set compatible 1284 mode to device");
                return ERROR_JTAG_INIT_FAILED;
        }
 #endif /* not __FreeBSD__, __FreeBSD_kernel__ */
 
 #else /* not PARPORT_USE_PPDEV */
-       if (parport_port == 0)
-       {
+       if (parport_port == 0) {
                parport_port = 0x378;
                LOG_WARNING("No parport port specified, using default '0x378' (LPT1)");
        }
@@ -360,11 +348,10 @@ static int parport_init(void)
 
        LOG_DEBUG("requesting privileges for parallel port 0x%lx...", dataport);
 #if PARPORT_USE_GIVEIO == 1
-       if (parport_get_giveio_access() != 0)
+       if (parport_get_giveio_access() != 0) {
 #else /* PARPORT_USE_GIVEIO */
-       if (ioperm(dataport, 3, 1) != 0)
+       if (ioperm(dataport, 3, 1) != 0) {
 #endif /* PARPORT_USE_GIVEIO */
-       {
                LOG_ERROR("missing privileges for direct i/o");
                return ERROR_JTAG_INIT_FAILED;
        }
@@ -385,8 +372,6 @@ static int parport_init(void)
 
        bitbang_interface = &parport_bitbang;
 
-       wait_states = jtag_get_speed();
-
        return ERROR_OK;
 }
 
@@ -394,14 +379,12 @@ static int parport_quit(void)
 {
        parport_led(0);
 
-       if (parport_exit)
-       {
+       if (parport_exit) {
                dataport_value = cable->PORT_EXIT;
                parport_write_data();
        }
 
-       if (parport_cable)
-       {
+       if (parport_cable) {
                free(parport_cable);
                parport_cable = NULL;
        }
@@ -411,21 +394,17 @@ static int parport_quit(void)
 
 COMMAND_HANDLER(parport_handle_parport_port_command)
 {
-       if (CMD_ARGC == 1)
-       {
+       if (CMD_ARGC == 1) {
                /* only if the port wasn't overwritten by cmdline */
                if (parport_port == 0)
-               {
                        COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], parport_port);
-               }
-               else
-               {
+               else {
                        LOG_ERROR("The parport port was already configured!");
                        return ERROR_FAIL;
                }
        }
 
-       command_print(CMD_CTX, "parport port = %u", parport_port);
+       command_print(CMD_CTX, "parport port = 0x%" PRIx16 "", parport_port);
 
        return ERROR_OK;
 }
@@ -436,22 +415,21 @@ COMMAND_HANDLER(parport_handle_parport_cable_command)
                return ERROR_OK;
 
        /* only if the cable name wasn't overwritten by cmdline */
-       if (parport_cable == 0)
-       {
+       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;
 }
 
 COMMAND_HANDLER(parport_handle_write_on_exit_command)
 {
        if (CMD_ARGC != 1)
-       {
-               command_print(CMD_CTX, "usage: parport_write_on_exit <on | off>");
-               return ERROR_OK;
-       }
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        COMMAND_PARSE_ON_OFF(CMD_ARGV[0], parport_exit);
 
@@ -473,7 +451,14 @@ COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
                }
 
                parport_toggling_time_ns = ns;
-               wait_states = jtag_get_speed();
+               retval = jtag_get_speed(&wait_states);
+               if (retval != ERROR_OK) {
+                       /* if jtag_get_speed fails then the clock_mode
+                        * has not been configured, this happens if parport_toggling_time is
+                        * called before the adapter speed is set */
+                       LOG_INFO("no parport speed set - defaulting to zero wait states");
+                       wait_states = 0;
+               }
        }
 
        command_print(CMD_CTX, "parport toggling time = %" PRIu32 " ns",
@@ -485,49 +470,50 @@ 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
 };
 
 struct jtag_interface parport_interface = {
-               .name = "parport",
-
-               .commands = parport_command_handlers,
-
-               .init = &parport_init,
-               .quit = &parport_quit,
-
-               .khz = &parport_khz,
-               .speed_div = &parport_speed_div,
-               .speed = &parport_speed,
-
-               .execute_queue = &bitbang_execute_queue,
-       };
+       .name = "parport",
+       .supported = DEBUG_CAP_TMS_SEQ,
+       .commands = parport_command_handlers,
+
+       .init = parport_init,
+       .quit = parport_quit,
+       .khz = parport_khz,
+       .speed_div = parport_speed_div,
+       .speed = parport_speed,
+       .execute_queue = bitbang_execute_queue,
+};

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)