Add read buffer to bitbang, improving performance.
[openocd.git] / src / jtag / drivers / parport.c
index b61f2f15e46c0695b33ec65234b2c2c992b21f2d..14fa9df9f7fdee1da797408bc6f697cdc0f45c0a 100644 (file)
  *   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.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -31,8 +30,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 +72,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 +80,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 +93,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 +116,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 +148,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 +169,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 +189,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 +202,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 +212,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 +223,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;
 
@@ -262,31 +266,27 @@ static struct bitbang_interface parport_bitbang = {
 
 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 == 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;
        }
@@ -294,8 +294,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 +311,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 +322,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 +353,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,31 +371,29 @@ 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;
 
-       int retval = jtag_get_speed(&wait_states);
-       if (retval != ERROR_OK)
-               return retval;
-
        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)
-       {
+       if (parport_cable) {
                free(parport_cable);
                parport_cable = NULL;
        }
@@ -412,15 +403,11 @@ 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;
                }
@@ -437,8 +424,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]);
@@ -452,10 +438,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);
 
@@ -478,8 +461,13 @@ COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
 
                parport_toggling_time_ns = ns;
                retval = jtag_get_speed(&wait_states);
-               if (retval != ERROR_OK)
-                       return retval;
+               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",

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)