flash/nor/at91samd: Use 32-bit register writes for ST-Link compat
[fw/openocd] / src / jtag / drivers / parport.c
index 2323ec56a95fa1b2736aff941a4eb0e5f4eb869c..4073d066e6f21eedfae5773d19954b2454323023 100644 (file)
@@ -1,29 +1,18 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
+#include <jtag/adapter.h>
 #include <jtag/interface.h>
 #include "bitbang.h"
 
@@ -31,8 +20,8 @@
 #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 {
-       char* name;
+       const 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,8 +62,7 @@ struct cable {
        uint8_t LED_MASK;       /* data port bit for LED */
 };
 
-static struct cable cables[] =
-{
+static const 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 },
@@ -83,8 +70,8 @@ static struct cable cables[] =
        { "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 },
-       { "triton",                     0x80, 0x08, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
+       { "dlc5",                               0x10, 0x00, 0x04, 0x02, 0x01, 0x00, 0x00, 0x00, 0x10, 0x10, 0x00 },
+       { "triton",                             0x80, 0x08, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
        { "lattice",                    0x40, 0x10, 0x04, 0x02, 0x01, 0x08, 0x00, 0x00, 0x18, 0x18, 0x00 },
        { "flashlink",                  0x20, 0x10, 0x02, 0x01, 0x04, 0x20, 0x30, 0x20, 0x00, 0x00, 0x00 },
 /* Altium Universal JTAG cable. Set the cable to Xilinx Mode and wire to target as follows:
@@ -96,20 +83,21 @@ static struct cable cables[] =
        SOFT TDI - Target SRST
 */
        { "altium",                     0x10, 0x20, 0x04, 0x02, 0x01, 0x80, 0x00, 0x00, 0x10, 0x00, 0x08 },
+       { "aspo",                       0x10, 0x01, 0x04, 0x08, 0x02, 0x10, 0x17, 0x00, 0x17, 0x17, 0x00 },
        { NULL,                         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
 };
 
 /* 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 cable* cable;
-static uint8_t dataport_value = 0x0;
+static const struct cable *cable;
+static uint8_t dataport_value;
 
 #if PARPORT_USE_PPDEV == 1
 static int device_handle;
@@ -118,23 +106,23 @@ static unsigned long dataport;
 static unsigned long statusport;
 #endif
 
-static int parport_read(void)
+static bb_value_t 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
 
        if ((data ^ cable->INPUT_INVERT) & cable->TDO_MASK)
-               return 1;
+               return BB_HIGH;
        else
-               return 0;
+               return BB_LOW;
 }
 
-static __inline__ void parport_write_data(void)
+static inline void parport_write_data(void)
 {
        uint8_t output;
        output = dataport_value ^ cable->OUTPUT_INVERT;
@@ -150,7 +138,7 @@ static __inline__ void parport_write_data(void)
 #endif
 }
 
-static void parport_write(int tck, int tms, int tdi)
+static int parport_write(int tck, int tms, int tdi)
 {
        int i = wait_states + 1;
 
@@ -171,10 +159,12 @@ static void parport_write(int tck, int tms, int tdi)
 
        while (i-- > 0)
                parport_write_data();
+
+       return ERROR_OK;
 }
 
 /* (1) assert or (0) deassert reset lines */
-static void parport_reset(int trst, int srst)
+static int parport_reset(int trst, int srst)
 {
        LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 
@@ -189,10 +179,12 @@ static void parport_reset(int trst, int srst)
                dataport_value &= ~cable->SRST_MASK;
 
        parport_write_data();
+
+       return ERROR_OK;
 }
 
 /* turn LED on parport adapter on (1) or off (0) */
-static void parport_led(int on)
+static int parport_led(int on)
 {
        if (on)
                dataport_value |= cable->LED_MASK;
@@ -200,6 +192,8 @@ static void parport_led(int on)
                dataport_value &= ~cable->LED_MASK;
 
        parport_write_data();
+
+       return ERROR_OK;
 }
 
 static int parport_speed(int speed)
@@ -208,7 +202,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");
@@ -219,7 +213,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;
 
@@ -233,7 +227,7 @@ static int parport_get_giveio_access(void)
        HANDLE h;
        OSVERSIONINFO version;
 
-       version.dwOSVersionInfoSize = sizeof version;
+       version.dwOSVersionInfoSize = sizeof(version);
        if (!GetVersionEx(&version)) {
                errno = EINVAL;
                return -1;
@@ -256,37 +250,32 @@ static int parport_get_giveio_access(void)
 static struct bitbang_interface parport_bitbang = {
                .read = &parport_read,
                .write = &parport_write,
-               .reset = &parport_reset,
                .blink = &parport_led,
        };
 
 static int parport_init(void)
 {
-       struct cable *cur_cable;
+       const struct cable *cur_cable;
 #if PARPORT_USE_PPDEV == 1
        char buffer[256];
 #endif
 
        cur_cable = cables;
 
-       if ((parport_cable == NULL) || (parport_cable[0] == 0))
-       {
-               parport_cable = "wiggler";
+       if (!parport_cable) {
+               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;
        }
@@ -294,8 +283,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;
        }
@@ -312,8 +300,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,32 +311,28 @@ static int parport_init(void)
 #if !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
        int i = ioctl(device_handle, PPCLAIM);
 
-       if (i < 0)
-       {
+       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)");
        }
@@ -359,11 +342,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;
        }
@@ -378,53 +360,47 @@ static int parport_init(void)
 
 #endif /* PARPORT_USE_PPDEV */
 
-       parport_reset(0, 0);
-       parport_write(0, 0, 0);
-       parport_led(1);
+       if (parport_reset(0, 0) != ERROR_OK)
+               return ERROR_FAIL;
+       if (parport_write(0, 0, 0) != ERROR_OK)
+               return ERROR_FAIL;
+       if (parport_led(1) != ERROR_OK)
+               return ERROR_FAIL;
 
        bitbang_interface = &parport_bitbang;
 
-       wait_states = jtag_get_speed();
-
        return ERROR_OK;
 }
 
 static int parport_quit(void)
 {
-       parport_led(0);
+       if (parport_led(0) != ERROR_OK)
+               return ERROR_FAIL;
 
-       if (parport_exit)
-       {
+       if (parport_exit) {
                dataport_value = cable->PORT_EXIT;
                parport_write_data();
        }
 
-       if (parport_cable)
-       {
-               free(parport_cable);
-               parport_cable = NULL;
-       }
+       free(parport_cable);
+       parport_cable = NULL;
 
        return ERROR_OK;
 }
 
 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 = 0x%" PRIx16 "", parport_port);
+       command_print(CMD, "parport port = 0x%" PRIx16 "", parport_port);
 
        return ERROR_OK;
 }
@@ -435,8 +411,7 @@ 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]);
@@ -450,10 +425,7 @@ COMMAND_HANDLER(parport_handle_parport_cable_command)
 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);
 
@@ -466,7 +438,7 @@ COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
                uint32_t ns;
                int retval = parse_u32(CMD_ARGV[0], &ns);
 
-               if (ERROR_OK != retval)
+               if (retval != ERROR_OK)
                        return retval;
 
                if (ns == 0) {
@@ -475,18 +447,25 @@ COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
                }
 
                parport_toggling_time_ns = ns;
-               wait_states = jtag_get_speed();
+               retval = adapter_get_speed(&wait_states);
+               if (retval != ERROR_OK) {
+                       /* if adapter_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",
+       command_print(CMD, "parport toggling time = %" PRIu32 " ns",
                        parport_toggling_time_ns);
 
        return ERROR_OK;
 }
 
-static const struct command_registration parport_command_handlers[] = {
+static const struct command_registration parport_subcommand_handlers[] = {
        {
-               .name = "parport_port",
+               .name = "port",
                .handler = parport_handle_parport_port_command,
                .mode = COMMAND_CONFIG,
                .help = "Display the address of the I/O port (e.g. 0x378) "
@@ -495,7 +474,7 @@ static const struct command_registration parport_command_handlers[] = {
                .usage = "[port_number]",
        },
        {
-               .name = "parport_cable",
+               .name = "cable",
                .handler = parport_handle_parport_cable_command,
                .mode = COMMAND_CONFIG,
                .help = "Set the layout of the parallel port cable "
@@ -504,7 +483,7 @@ static const struct command_registration parport_command_handlers[] = {
                .usage = "[layout]",
        },
        {
-               .name = "parport_write_on_exit",
+               .name = "write_on_exit",
                .handler = parport_handle_write_on_exit_command,
                .mode = COMMAND_CONFIG,
                .help = "Configure the parallel driver to write "
@@ -512,7 +491,7 @@ static const struct command_registration parport_command_handlers[] = {
                .usage = "('on'|'off')",
        },
        {
-               .name = "parport_toggling_time",
+               .name = "toggling_time",
                .handler = parport_handle_parport_toggling_time_command,
                .mode = COMMAND_CONFIG,
                .help = "Displays or assigns how many nanoseconds it "
@@ -522,15 +501,33 @@ static const struct command_registration parport_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-struct jtag_interface parport_interface = {
-       .name = "parport",
+static const struct command_registration parport_command_handlers[] = {
+       {
+               .name = "parport",
+               .mode = COMMAND_ANY,
+               .help = "perform parport management",
+               .chain = parport_subcommand_handlers,
+               .usage = "",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+static struct jtag_interface parport_interface = {
        .supported = DEBUG_CAP_TMS_SEQ,
+       .execute_queue = bitbang_execute_queue,
+};
+
+struct adapter_driver parport_adapter_driver = {
+       .name = "parport",
+       .transports = jtag_only,
        .commands = parport_command_handlers,
 
        .init = parport_init,
        .quit = parport_quit,
+       .reset = parport_reset,
+       .speed = parport_speed,
        .khz = parport_khz,
        .speed_div = parport_speed_div,
-       .speed = parport_speed,
-       .execute_queue = bitbang_execute_queue,
+
+       .jtag_ops = &parport_interface,
 };